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 JSON ( canonical form + also see JSON Format Specification )
An example transaction
{
"resourceType": "Bundle",
"id": "bundle-transaction",
"meta": {
"lastUpdated": "2014-08-18T01:43:30Z"
"resourceType" : "Bundle",
"id" : "bundle-transaction",
"meta" : {
"lastUpdated" : "2014-08-18T01:43:30Z"
},
"type": "transaction",
"entry": [
{
"fullUrl": "urn:uuid:61ebe359-bfdc-4613-8bf2-c5e300945f0a",
"resource": {
"resourceType": "Patient",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"active": true,
"name": [
{
"use": "official",
"family": "Chalmers",
"given": [
"Peter",
"James"
]
}
],
"gender": "male",
"birthDate": "1974-12-25"
"type" : "transaction",
"entry" : [{
"fullUrl" : "urn:uuid:61ebe359-bfdc-4613-8bf2-c5e300945f0a",
"resource" : {
"resourceType" : "Patient",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"request": {
"method": "POST",
"url": "Patient"
}
"active" : true,
"name" : [{
"use" : "official",
"family" : "Chalmers",
"given" : ["Peter",
"James"]
}],
"gender" : "male",
"birthDate" : "1974-12-25"
},
{
"fullUrl": "urn:uuid:88f151c0-a954-468a-88bd-5ae15c08e059",
"resource": {
"resourceType": "Patient",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"identifier": [
{
"system": "http:/example.org/fhir/ids",
"value": "234234"
}
],
"active": true,
"name": [
{
"use": "official",
"family": "Chalmers",
"given": [
"Peter",
"James"
]
}
],
"gender": "male",
"birthDate": "1974-12-25"
"request" : {
"method" : "POST",
"url" : "Patient"
}
},
{
"fullUrl" : "urn:uuid:88f151c0-a954-468a-88bd-5ae15c08e059",
"resource" : {
"resourceType" : "Patient",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"request": {
"method": "POST",
"url": "Patient",
"ifNoneExist": "identifier=http:/example.org/fhir/ids|234234"
}
"identifier" : [{
"system" : "http:/example.org/fhir/ids",
"value" : "234234"
}],
"active" : true,
"name" : [{
"use" : "official",
"family" : "Chalmers",
"given" : ["Peter",
"James"]
}],
"gender" : "male",
"birthDate" : "1974-12-25"
},
{
"fullUrl": "http://example.org/fhir/Patient/123",
"resource": {
"resourceType": "Patient",
"id": "123",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"active": true,
"name": [
{
"use": "official",
"family": "Chalmers",
"given": [
"Peter",
"James"
]
}
],
"gender": "male",
"birthDate": "1974-12-25"
"request" : {
"method" : "POST",
"url" : "Patient",
"ifNoneExist" : "identifier=http:/example.org/fhir/ids|234234"
}
},
{
"fullUrl" : "http://example.org/fhir/Patient/123",
"resource" : {
"resourceType" : "Patient",
"id" : "123",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"request": {
"method": "PUT",
"url": "Patient/123"
}
"active" : true,
"name" : [{
"use" : "official",
"family" : "Chalmers",
"given" : ["Peter",
"James"]
}],
"gender" : "male",
"birthDate" : "1974-12-25"
},
{
"fullUrl": "urn:uuid:74891afc-ed52-42a2-bcd7-f13d9b60f096",
"resource": {
"resourceType": "Patient",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"identifier": [
{
"system": "http:/example.org/fhir/ids",
"value": "456456"
}
],
"active": true,
"name": [
{
"use": "official",
"family": "Chalmers",
"given": [
"Peter",
"James"
]
}
],
"gender": "male",
"birthDate": "1974-12-25"
"request" : {
"method" : "PUT",
"url" : "Patient/123"
}
},
{
"fullUrl" : "urn:uuid:74891afc-ed52-42a2-bcd7-f13d9b60f096",
"resource" : {
"resourceType" : "Patient",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"request": {
"method": "PUT",
"url": "Patient?identifier=http:/example.org/fhir/ids|456456"
}
"identifier" : [{
"system" : "http:/example.org/fhir/ids",
"value" : "456456"
}],
"active" : true,
"name" : [{
"use" : "official",
"family" : "Chalmers",
"given" : ["Peter",
"James"]
}],
"gender" : "male",
"birthDate" : "1974-12-25"
},
{
"fullUrl": "http://example.org/fhir/Patient/123a",
"resource": {
"resourceType": "Patient",
"id": "123a",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"active": true,
"name": [
{
"use": "official",
"family": "Chalmers",
"given": [
"Peter",
"James"
]
}
],
"gender": "male",
"birthDate": "1974-12-25"
"request" : {
"method" : "PUT",
"url" : "Patient?identifier=http:/example.org/fhir/ids|456456"
}
},
{
"fullUrl" : "http://example.org/fhir/Patient/123a",
"resource" : {
"resourceType" : "Patient",
"id" : "123a",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Some narrative</div>"
},
"request": {
"method": "PUT",
"url": "Patient/123a",
"ifMatch": "W/\"2\""
}
},
{
"request": {
"method": "DELETE",
"url": "Patient/234"
}
},
{
"request": {
"method": "DELETE",
"url": "Patient?identifier=123456"
}
"active" : true,
"name" : [{
"use" : "official",
"family" : "Chalmers",
"given" : ["Peter",
"James"]
}],
"gender" : "male",
"birthDate" : "1974-12-25"
},
{
"fullUrl": "urn:uuid:79378cb8-8f58-48e8-a5e8-60ac2755b674",
"resource": {
"resourceType": "Parameters",
"parameter": [
{
"name": "coding",
"valueCoding": {
"system": "http://loinc.org",
"code": "1963-8"
}
}
]
"request" : {
"method" : "PUT",
"url" : "Patient/123a",
"ifMatch" : "W/\"2\""
}
},
{
"fullUrl" : "urn:uuid:f6240915-8e9f-4e21-ac6d-ea68ff6b90eb",
"resource" : {
"resourceType" : "Provenance",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Provenance </b></p><p>Provenance for: </p><ul><li><a href=\"broken-link.html\">urn:uuid:88f151c0-a954-468a-88bd-5ae15c08e059</a></li><li><a href=\"broken-link.html\">http://example.org/fhir/Patient/123a</a></li></ul><p>Summary</p><table class=\"grid\"><tr><td>Activity</td><td><span title=\"Codes:\">data entry</span></td></tr></table><p><b>Agents</b></p><table class=\"grid\"><tr><td><b>who</b></td></tr><tr><td>Clerical Staff</td></tr></table></div>"
},
"request": {
"method": "POST",
"url": "ValueSet/$lookup"
}
"target" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/resolve-as-version-specific",
"valueBoolean" : true
}],
"reference" : "urn:uuid:88f151c0-a954-468a-88bd-5ae15c08e059"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/resolve-as-version-specific",
"valueBoolean" : true
}],
"reference" : "http://example.org/fhir/Patient/123a"
}],
"activity" : {
"text" : "data entry"
},
"agent" : [{
"who" : {
"display" : "Clerical Staff"
}
}]
},
{
"request": {
"method": "GET",
"url": "Patient?name=peter"
}
"request" : {
"method" : "POST",
"url" : "Provenance"
}
},
{
"request" : {
"method" : "DELETE",
"url" : "Patient/234"
}
},
{
"request" : {
"method" : "DELETE",
"url" : "Patient?identifier=123456"
}
},
{
"fullUrl" : "urn:uuid:79378cb8-8f58-48e8-a5e8-60ac2755b674",
"resource" : {
"resourceType" : "Parameters",
"parameter" : [{
"name" : "coding",
"valueCoding" : {
"system" : "http://loinc.org",
"code" : "1963-8"
}
}]
},
{
"request": {
"method": "GET",
"url": "Patient/12334",
"ifNoneMatch": "W/\"4\"",
"ifModifiedSince": "2015-08-31T08:14:33+10:00"
}
"request" : {
"method" : "POST",
"url" : "http://hl7.org/fhir/ValueSet/$lookup"
}
]
},
{
"request" : {
"method" : "GET",
"url" : "Patient?name=peter"
}
},
{
"request" : {
"method" : "GET",
"url" : "Patient/12334",
"ifNoneMatch" : "W/\"4\"",
"ifModifiedSince" : "2015-08-31T08:14:33+10:00"
}
}]
}
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,
Thu,
Nov
1,
2019
09:34+1100.
QA
Page
27,
2025
16:53+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