# IPS Summary - International Patient Summary Implementation Guide v2.0.0

## OperationDefinition: IPS Summary 

 
This operation returns an IPS document in response to a POST/GET request (see[FHIR Operations](https://hl7.org/fhir/operations.html)). The returned document MAY be generated on-demand and SHOULD represent the latest available information. This operation would not necessarily create a persisted IPS instance on the server responding to the request. When historic records or other documents are desired, this operation is not appropriate. For alternative operations and IPS generation guidance, please see[IPS Generation and Data Inclusion](./Generation-and-Data-Inclusion.md) 
Generally when a patient's logical id is known, that id would be used to request the patient summary from a FHIR server (see [id] pattern below). When it is not known, servers MAY support using other identifiers (see identifier parameter below). When [base]/Patient/$summary is used, requestors SHALL provide an identifier. 
Servers MAY support profiles beyond the IPS. When supported, other profiles can be specified using the profile parameter. When not supported, servers MAY use the universal IPS Composition profile to identify what profile is returned by default. 

URL: [base]/Patient/$summary

URL: [base]/Patient/[id]/$summary

### Parameters

* **Use**: IN
  * **Name**: identifier
  * **Scope**: 
  * **Cardinality**: 0..1
  * **Type**: [string](http://hl7.org/fhir/R4/datatypes.html#string)([token](https://hl7.org/fhir/R4/search.html#token))
  * **Binding**: 
  * **Documentation**: When the logical id of the patient is not used, servers MAY choose to support patient selection based on provided identifier. Unless the identifier system is unknown, requestors SHOULD include both the system and value (e.g. 'identifier=https://standards.digital.health.nz/ns/nhi-id|CNNJ9186') when using this parameter.
* **Use**: IN
  * **Name**: profile
  * **Scope**: 
  * **Cardinality**: 0..1
  * **Type**: [canonical](http://hl7.org/fhir/R4/datatypes.html#canonical)
  * **Binding**: 
  * **Documentation**: A specific profile for the patient summary may be specified. By default, servers MAY use the universal Composition profile to identify what profile the returned summary will adhere to. This is intended as a more flexible approach for implementers to support derivations of the IPS (e.g. national and jurisdictional implementations). A specific version may be requested using a canonical reference (e.g. http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips|2.0.0)
* **Use**: OUT
  * **Name**: return
  * **Scope**: 
  * **Cardinality**: 0..1
  * **Type**: [Bundle](http://hl7.org/fhir/R4/bundle.html)
  * **Binding**: 
  * **Documentation**: The Bundle returned is a document conforming to the specified input Composition profile parameter or the International Patient Summary [Composition profile](./StructureDefinition-Composition-uv-ips.md) (if not otherwise specified)



## Resource Content

```json
{
  "resourceType" : "OperationDefinition",
  "id" : "summary",
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pc"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 3,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/ips/OperationDefinition/summary",
  "version" : "2.0.0",
  "name" : "IpsSummary",
  "title" : "IPS Summary",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-07-15T13:15:56.964-00:00",
  "publisher" : "HL7 International / Patient Care",
  "contact" : [
    {
      "name" : "HL7 International / Patient Care",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/patientcare"
        }
      ]
    }
  ],
  "description" : "This operation returns an IPS document in response to a POST/GET request (see [FHIR Operations](https://hl7.org/fhir/operations.html)).  The returned document MAY be generated on-demand and SHOULD represent the latest available information. This operation would not necessarily create a persisted IPS instance on the server responding to the request. When historic records or other documents are desired, this operation is not appropriate. For alternative operations and IPS generation guidance, please see [IPS Generation and Data Inclusion](./Generation-and-Data-Inclusion.html) \n\nGenerally when a patient's logical id is known, that id would be used to request the patient summary from a FHIR server (see [id] pattern below). When it is not known, servers MAY support using other identifiers (see identifier parameter below). When [base]/Patient/$summary is used, requestors SHALL provide an identifier.\n\nServers MAY support profiles beyond the IPS. When supported, other profiles can be specified using the profile parameter. When not supported, servers MAY use the universal IPS Composition profile to identify what profile is returned by default.  \n",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "summary",
  "resource" : ["Patient"],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "identifier",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "When the logical id of the patient is not used, servers MAY choose to support patient selection based on provided identifier. Unless the identifier system is unknown, requestors SHOULD include both the system and value (e.g. 'identifier=https://standards.digital.health.nz/ns/nhi-id|CNNJ9186') when using this parameter.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "profile",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A specific profile for the patient summary may be specified. By default, servers MAY use the universal Composition profile to identify what profile the returned summary will adhere to.  This is intended as a more flexible approach for implementers to support derivations of the IPS (e.g. national and jurisdictional implementations). A specific version may be requested using a canonical reference (e.g. http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips|2.0.0)",
      "type" : "canonical"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "The Bundle returned is a document conforming to the specified input Composition profile parameter or the International Patient Summary [Composition profile](./StructureDefinition-Composition-uv-ips.html) (if not otherwise specified)",
      "type" : "Bundle"
    }
  ]
}

```
