Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

Example Bundle/bundle-response-medsallergies (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw JSON (canonical form + also see JSON Format Specification)

Response for Retrieve a patients medications, allergies, problems and immunizations

{
  "resourceType": "Bundle",
  "id": "bundle-response-medsallergies",
  "type": "batch-response",
  "entry": [
    {
      "resource": {
        "resourceType": "Patient",
        "id": "example",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2018-11-12T03:35:20.715Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n                        <table>\n                            <tbody>\n                                <tr>\n                                    <td>Name</td>\n                                    <td>Peter James \n                                        <b>Chalmers</b> (&quot;Jim&quot;)\n                                    </td>\n                                </tr>\n                                <tr>\n                                    <td>Address</td>\n                                    <td>534 Erewhon, Pleasantville, Vic, 3999</td>\n                                </tr>\n                                <tr>\n                                    <td>Contacts</td>\n                                    <td>Home: unknown. Work: (03) 5555 6473</td>\n                                </tr>\n                                <tr>\n                                    <td>Id</td>\n                                    <td>MRN: 12345 (Acme Healthcare)</td>\n                                </tr>\n                            </tbody>\n                        </table>\n                    </div>"
        },
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "MR"
                }
              ]
            },
            "system": "urn:oid:1.2.36.146.595.217.0.1",
            "value": "12345",
            "period": {
              "start": "2001-05-06"
            },
            "assigner": {
              "display": "Acme Healthcare"
            }
          }
        ],
        "active": true,
        "name": [
          {
            "use": "official",
            "family": "Chalmers",
            "given": [
              "Peter",
              "James"
            ]
          },
          {
            "use": "usual",
            "given": [
              "Jim"
            ]
          },
          {
            "use": "maiden",
            "family": "Windsor",
            "given": [
              "Peter",
              "James"
            ],
            "period": {
              "end": "2002"
            }
          }
        ],
        "telecom": [
          {
            "use": "home"
          },
          {
            "system": "phone",
            "value": "(03) 5555 6473",
            "use": "work",
            "rank": 1
          },
          {
            "system": "phone",
            "value": "(03) 3410 5613",
            "use": "mobile",
            "rank": 2
          },
          {
            "system": "phone",
            "value": "(03) 5555 8834",
            "use": "old",
            "period": {
              "end": "2014"
            }
          }
        ],
        "gender": "male",
        "birthDate": "1974-12-25",
        "_birthDate": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime",
              "valueDateTime": "1974-12-25T14:35:45-05:00"
            }
          ]
        },
        "deceasedBoolean": false,
        "address": [
          {
            "use": "home",
            "type": "both",
            "text": "534 Erewhon St PeasantVille, Rainbow, Vic  3999",
            "line": [
              "534 Erewhon St"
            ],
            "city": "PleasantVille",
            "district": "Rainbow",
            "state": "Vic",
            "postalCode": "3999",
            "period": {
              "start": "1974-12-25"
            }
          }
        ],
        "contact": [
          {
            "relationship": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
                    "code": "N"
                  }
                ]
              }
            ],
            "name": {
              "family": "du Marché",
              "_family": {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
                    "valueString": "VV"
                  }
                ]
              },
              "given": [
                "Bénédicte"
              ]
            },
            "telecom": [
              {
                "system": "phone",
                "value": "+33 (237) 998327"
              }
            ],
            "address": {
              "use": "home",
              "type": "both",
              "line": [
                "534 Erewhon St"
              ],
              "city": "PleasantVille",
              "district": "Rainbow",
              "state": "Vic",
              "postalCode": "3999",
              "period": {
                "start": "1974-12-25"
              }
            },
            "gender": "female",
            "period": {
              "start": "2012"
            }
          }
        ],
        "managingOrganization": {
          "reference": "Organization/1"
        }
      },
      "response": {
        "status": "200",
        "etag": "W/1",
        "lastModified": "2018-11-12T03:35:20.717Z"
      }
    },
    {
      "resource": {
        "resourceType": "Bundle",
        "id": "5bdf95d0-24a6-4024-95f5-d546fb479b",
        "meta": {
          "lastUpdated": "2018-11-12T05:42:16.086Z"
        },
        "type": "searchset",
        "total": 0,
        "link": [
          {
            "relation": "self",
            "url": "http://test.fhir.org/r5/MedicationUsage?_format=application/fhir+xml&search-id=804eee4a-0a54-4414-9c07-169952f929&&patient=example&_list=%24current%2Dmedications&_sort=_id"
          }
        ]
      },
      "response": {
        "status": "200",
        "etag": "W/1",
        "lastModified": "2018-11-12T03:35:20.717Z"
      }
    },
    {
      "resource": {
        "resourceType": "Bundle",
        "id": "0c11a91c-3638-4d58-8cf1-40e60f43c6",
        "meta": {
          "lastUpdated": "2018-11-12T05:42:16.209Z"
        },
        "type": "searchset",
        "total": 0,
        "link": [
          {
            "relation": "self",
            "url": "http://test.fhir.org/r5/AllergyIntolerance?_format=application/fhir+xml&search-id=b1981f8a-4139-4db6-923d-77d764c990&&patient=example&_list=%24current%2Dallergies&_sort=_id"
          }
        ]
      },
      "response": {
        "status": "200",
        "etag": "W/1",
        "lastModified": "2018-11-12T03:35:20.717Z"
      }
    },
    {
      "resource": {
        "resourceType": "Bundle",
        "id": "19f0fa29-f8fe-4b07-b035-f488893f06",
        "meta": {
          "lastUpdated": "2018-11-12T05:42:16.279Z"
        },
        "type": "searchset",
        "total": 0,
        "link": [
          {
            "relation": "self",
            "url": "http://test.fhir.org/r5/Condition?_format=application/fhir+xml&search-id=4d097c43-54aa-4157-b500-be22208dd0&&patient=example&_list=%24current%2Dproblems&_sort=_id"
          }
        ]
      },
      "response": {
        "status": "200",
        "etag": "W/1",
        "lastModified": "2018-11-12T03:35:20.717Z"
      }
    },
    {
      "resource": {
        "resourceType": "Bundle",
        "id": "dff8ab42-33f9-42ec-88c5-83d3f05323",
        "meta": {
          "lastUpdated": "2018-11-12T05:42:16.351Z"
        },
        "type": "searchset",
        "total": 0,
        "link": [
          {
            "relation": "self",
            "url": "http://test.fhir.org/r5/MedicationUsage?_format=application/fhir+xml&search-id=31d4af75-cdcf-4f85-9666-4bafadebb5&&patient=example&_sort=_id"
          }
        ]
      },
      "response": {
        "status": "200",
        "etag": "W/1",
        "lastModified": "2018-11-12T03:35:20.717Z"
      }
    }
  ]
}

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.