Summary Parameter

The client can request the server to return only a portion of the resources by using the parameter _summary.

GET [base]/Patient?_summary=true

The _summary parameter requests the server to return a subset of the resource. It can contain one of the following values:

Table 11-5 Summary Parameter Values

Value	Description
true	Return a limited subset of elements from the resource.
text	Return only the text, id, meta, and top-level mandatory elements.
data	Remove the text element.
count	Search only: just return a count of the matching resources, without returning the actual matches.
false	Return all parts of the resource(s).

Sample Response of _summary=true

GET [base]/Patient?_summary=true

{
  "resourceType": "Bundle",
  "id": "71702ee9-4046-49c0-9840-0fe139a2afd1",
  "meta": {
    "lastUpdated": "2024-02-26T08:34:47.477+00:00",
    "tag": [ {
      "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code": "SUBSETTED",
      "display": "Resource encoded in summary mode"
    } ]
  },
  "type": "searchset",
  "total": 1,
  "link": [ {
    "relation": "self",
    "url": "http://hsgbu-lon-166.snlhrprshared1.gbucdsint02lhr.oraclevcn.com:3003/oracle-fhir-server/fhir/Patient?_summary=true"
  } ],
  "entry": [ {
    "fullUrl": "http://hsgbu-lon-166.snlhrprshared1.gbucdsint02lhr.oraclevcn.com:3003/oracle-fhir-server/fhir/Patient/1",
    "resource": {
      "resourceType": "Patient",
      "id": "1",
      "meta": {
        "versionId": "1",
        "lastUpdated": "2024-02-26T06:59:39.364+00:00",
        "source": "#rIx8lDj54KOhTZF0",
        "tag": [ {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
          "code": "SUBSETTED",
          "display": "Resource encoded in summary mode"
        } ]
      },
      "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": "[phone]",
        "use": "work",
        "rank": 1
      }, {
        "system": "phone",
        "value": "[phone]",
        "use": "mobile",
        "rank": 2
      }, {
        "system": "phone",
        "value": "[phone]",
        "use": "old",
        "period": {
          "end": "2014"
        }
      } ],
      "gender": "male",
      "birthDate": "1974-12-25",
      "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"
        }
      } ]
    },
    "search": {
      "mode": "match"
    }
  } ]
}