International Patient Summary (IPS) Generator

The International Patient Summary (IPS) is a specification for a health record summary extract. It is supported in FHIR through the International Patient Summary Implementation Guide (http://hl7.org/fhir/uv/ips/).

An IPS is expressed as a FHIR Document in FHIR. The HDR FHIR server supports the automated generation of IPS documents through the $summary operation. And HDR FHIR supports this feature for R4 version.

The IPS Generator uses FHIR resources stored in HDR FHIR repository as its input. The IPS Document includes a Composition resource, and this composition must include a populated narrative for each section containing the relevant clinical details for the section. The IPS generator user the default narrative template.

Narrative templates for individual sections will be supplied a Bundle resource containing only the matched resources for the individual section as entries. (For example, the Composition itself will not be present and no other resources will be present.) The default narrative properties file should define with the default built-in Narrative templates.

################################################
# IPS Sections
################################################

ips-allergyintolerance.resourceType=Bundle
ips-allergyintolerance.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionAllergies
ips-allergyintolerance.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/allergyintolerance.html

ips-medicationsummary.resourceType=Bundle
ips-medicationsummary.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionMedications
ips-medicationsummary.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/medicationsummary.html

ips-problemlist.resourceType=Bundle
ips-problemlist.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionProblems
ips-problemlist.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/problemlist.html

ips-immunizations.resourceType=Bundle
ips-immunizations.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionImmunizations
ips-immunizations.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/immunizations.html

ips-historyofprocedures.resourceType=Bundle
ips-historyofprocedures.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionProceduresHx
ips-historyofprocedures.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/historyofprocedures.html

ips-medicaldevices.resourceType=Bundle
ips-medicaldevices.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionMedicalDevices
ips-medicaldevices.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/medicaldevices.html

ips-diagnosticresults.resourceType=Bundle
ips-diagnosticresults.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionResults
ips-diagnosticresults.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/diagnosticresults.html

ips-vitalsigns.resourceType=Bundle
ips-vitalsigns.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionVitalSigns
ips-vitalsigns.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/vitalsigns.html

ips-pregnancy.resourceType=Bundle
ips-pregnancy.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionPregnancyHx
ips-pregnancy.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/pregnancy.html

ips-socialhistory.resourceType=Bundle
ips-socialhistory.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionSocialHistory
ips-socialhistory.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/socialhistory.html

ips-pasthistoryofillness.resourceType=Bundle
ips-pasthistoryofillness.profile=http://hl7.org/fhir/uv/ips/StructureDefinition/PastHistoryOfIllness-uv-ips
ips-pasthistoryofillness.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/pasthistoryofillness.html

ips-functionalstatus.resourceType=Bundle
ips-functionalstatus.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionFunctionalStatus
ips-functionalstatus.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/functionalstatus.html

ips-planofcare.resourceType=Bundle
ips-planofcare.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionPlanOfCare
ips-planofcare.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/planofcare.html

ips-advancedirectives.resourceType=Bundle
ips-advancedirectives.profile=https://hl7.org/fhir/uv/ips/StructureDefinition-Composition-uv-ips-definitions.html#Composition.section:sectionAdvanceDirectives
ips-advancedirectives.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/advancedirectives.html

################################################
# Utility Fragments
################################################

ips-utility-fragments.fragmentName=IpsUtilityFragments
ips-utility-fragments.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/utility-fragments.html

################################################
# IPS Global Composition Narrative (applied at the end)
################################################

ips-global.resourceType=Composition
ips-global.narrative=classpath:ca/uhn/fhir/jpa/ips/narrative/composition.html

The generation of IPS documents will be done through the $summary operation. This operation is used to return a patient summary using the default IPS Narrative templates.

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

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