---
title: "International Patient Summary (IPS)"
canonical: "https://wiki.patientsknowbest.com/space/api/4881055787/International%20Patient%20Summary%20(IPS)"
format: markdown
---
> Macro (toc)

# Why

An [International Patient Summary (IPS)](https://build.fhir.org/ig/HL7/fhir-ips/) is a standardised, concise overview of a person's most important health information, designed to be quickly understood by healthcare professionals worldwide. 

# What

PKB helps by gathering and organising health information in a standard way, allowing other systems to easily extract patient data that conforms to the universally accepted IPS format. This makes it possible for external systems to create and share an IPS, ensuring critical health details can be understood and shared across care settings.

# How

![image-20260819-142700.png](media://1925f15b-d759-42e7-a88f-8676142c517a)

# IPS Sections

## Document Information

### Patient

Patient demographics can be obtained fro PKB by pulling the [FHIR Patient Resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Patient-(IPS)).

### Author

Individual FHIR resources may contain their own information in regards to the practitioner and organisation, but this is not equivalent to document-level authorship. Therefore this information would be populated by the IPS creator and not obtained from PKB.

### Attester

Individual FHIR resources may contain their own information in regards to the practitioner and organisation, but this is not equivalent to document-level attester. Therefore this information would be populated by the IPS creator and not obtained from PKB.

### Custodian

Individual FHIR resources may contain their own information in regards to the organisation, but this is not equivalent to document-level custodianship. Therefore this information would be populated by the IPS creator and not obtained from PKB.

## Required

### Problems

Pull the [Condition FHIR Resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Condition-(IPS)) to obtain this information.

### Allergies and Intolerances

Pull the [AllergyIntolerance FHIR Resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#AllergyIntolerance-(IPS)) to obtain this information.

### Medication Summary

Pull the [Medication](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Medication-(IPS)), [MedicationRequest](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#MedicationRequest-(IPS)) and [MedicationStatement](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#MedicationStatement-(IPS)) FHIR Resources to get a full Medication Summary for the patient. 

## Recommended

### Immunizations

Pull the [Immunization FHIR Resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Immunization-(IPS)) to obtain this information.

### Results

Pull the[ Observation, Specimen, and Device - Performer or Observer FHIR resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Observation-(IPS))s to obtain the laboratory/pathology and radiology results.

### History of Procedures

Pull the [Procedure](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Procedure-(IPS)) and [Device - Performer or Observer](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Device---Performer-or-Observer-(IPS)) FHIR resources to obtain this information.

### Medical Devices

Pull the [Device](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Device-(IPS)) and [DeviceUseStatement ](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#DeviceUseStatement-(IPS))FHIR resources to obtain this information.

## Optional

### Advance Directives

IPS defines Advanced Directives to use the Consent and DocumentReference FHIR resources. PKB does expose a FHIR Consent resource, but this contains PKB’s record-access sharing (who a patient has shared their record with, and which privacy labels those people can see), not treatment preferences.

### Alerts

Pull the [FHIR Flag Resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Flag---Alert-(IPS)) to obtain this information.

### Functional Status

Pull the [Condition](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Condition-(IPS)) or [ClinicalImpression](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#ClinicalImpression-(IPS)) FHIR resources to obtain this information.  

### History of Past Problems

Pull the [FHIR Condition Resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Condition-(IPS)) to obtain this information..

### History of Pregnancy

Pull the [FHIR Observation resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Observation-(IPS)) to obtain the Pregnancy Expected Delivery Date, Outcome and Status.

### Patient Story

Patient-entered information held in the [CarePlan](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#CarePlan-(IPS)) FHIR resource may be applicable for this part of the IPS. 

### Plan of Care

Pull the [CarePlan](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#CarePlan-(IPS)) and [ImmunizationRecommendation](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#ImmunizationRecommendation-(IPS)) FHIR resources to obtain this information.  

### Social History

Pull the [Observation FHIR resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Observation-(IPS)) using a category code search parameter of social-history to obtain information on the patient's alcohol and tobacco use.

### Vital Signs

Pull the [Observation FHIR resource](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/4881055787/International+Patient+Summary+IPS#Observation-(IPS)) using a category code search parameter of vital-signs to obtain a patient’s vital signs.


# List of FHIR Resources

**Executing the following URLs as GET requests will provide all the FHIR data required to populate the IPS sections as detailed above.**

*Some of the requests may result in large amounts of data, so you should be able to handle and work with the pagination PKB utilises.*

## AllergyIntolerance (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/AllergyIntolerance?patient:Patient.identifier={identifierSystem}|{patientIdentifier}

## CarePlan (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/CarePlan?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## ClinicalImpression (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/ClinicalImpression?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## Condition (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Condition?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## Device (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Device?patient:Patient.identifier={identifierSystem}|{patientIdentifier}

## Device - Performer or Observer (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Device/{Device resource id}

## DeviceUseStatement (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/DeviceUseStatement?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## Flag - Alert (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Flag?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## Immunization (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Immunization?patient:Patient.identifier={identifierSystem}|{patientIdentifier}

## ImmunizationRecommendation (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/ImmunizationRecommendation?patient:Patient.identifier={identifierSystem}|{patientIdentifier}

## Medication (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Medication/{Medication resource id}

## MedicationRequest (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/MedicationRequest?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## MedicationStatement (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/MedicationStatement?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## Observation (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Observation?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

*Additional parameters can be used to filter for specific things (e.g., code, category, etc.)*

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Observation?subject:Patient.identifier={identifierSystem}|{patientIdentifier}&category=social-history

## Patient (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Patient?identifier={identifierSystem}|{patientIdentifier}

## Procedure (IPS) 

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Procedure?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

## Specimen (IPS)

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Specimen?subject:Patient.identifier={identifierSystem}|{patientIdentifier}

# Coming Later

**Organisation (IPS) **https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Organization/{resource id}

**Practitioner (IPS) **https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/Practitioner/{resource id}

**PractitionerRole (IPS)**

https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/PractitionerRole?practitioner={practitioner resource id}