International Patient Summary Implementation Guide Implementation Guide Release 0.1.0

This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Profiles defined as part of the IPS Guide

Bundle and Composition

The International Patient Summary is a document. All the profiles specified by this guide are used by the International Patient Summary Composition.

The Bundle used for the transport or the persitence SHALL include all the resources that are referenced directly or indirectly by a International Patient Summary Composition.

The IPS includes the following sections, (R) denotes a required section (i.e. must be present in an IPS), (S) denotes a recommended section, the others are truely optional. For each section the profiles that have been defined have been listed:

  • Medication Summary (R)
    • Medication-uv-ips
    • MedicationStatement-uv-ips
  • Allergies and Intolerances (R)
    • AllergyIntolerance-uv-ips
  • Problem List (R)
    • Condition-uv-ips
  • Immunizations (S)
    • Immunization-uv-ips
  • History of Procedures (S)
  • Procedure-uv-ips
  • Medical Devices (S)
    • DeviceUseStatement-uv-ips
    • Device-uv-ips
  • Diagnostic Results (S)
    • Laboratory results
      • Specimen-uv-ips
      • Organization-laboratory-uv-ips
      • Observation-attachment-uv-ips
      • Observation-laboratory-uv-ips
      • Observation-member-laboratory-uv-ips
    • Radiology results
      • Observation-imaging-uv-ips.structuredefinition
      • Observation-member-imaging-uv-ips.structuredefinition
      • ImagingStudy-uv-ips.structuredefinition
      • Organization-observation-uv-ips.structuredefinition
      • Device-observer-uv-ips.structuredefinition
      • Practitioner-observation-uv-ips.structuredefinition
    • Pathology results
      • Observation-member-pathology-uv-ips.structuredefinition
      • Observation-pathology-uv-ips.structuredefinition
    • Other results
      • Observation-uv-ips
  • Past history of illnesses
  • Pregnancy (status and history summary)
    • Observation-pregnancy-edd-uv-ips
    • Observation-pregnancy-outcome-uv-ips
    • Observation-pregnancy-status-uv-ips
  • Social History
    • Observation-tobaccoUse-uv-ips
    • Observation-alcoholUse-uv-ips
  • Functional Status (Autonomy / Invalidity)
  • Plan of care
  • Advance Directives

(Vital Signs has not yet included)

IPS Data types

Two classes of data types profiles have been defined for the IPS:

  • A first class designed to support multi-languages for Narratives and displays:
    • Narrative-uv-ips
    • coding-uv-ips
    • CodeableConcept-uv-ips
  • A second one defined to restrict the usage of quantity-related data types to UCUM as system for units.
    • Quantity-uv-ips
    • Range-uv-ips
    • Ratio-uv-ips

List of Profiles

The links to the Profiles that have been defined for this implementation guide are listed hereafter.

  • AllergyIntolerance-uv-ips This profile represents the constraints applied to the AllergyIntolerance resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an allergy or intolerance is represented in the patient summary as an instance of an AllergyIntolerance resource constrained by this profile. It documents the relevant allergies or intolerances (conditions) for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.
  • Composition-uv-ips Clinical document used to represent the International Patient Summary (IPS) data set. The IPS dataset is a minimal and non-exhaustive patient summary dataset, specialty-agnostic, condition-independent, but readily usable by clinicians for the cross-border unscheduled care of a patient. This profile is based on the ClinicalDocument profile
  • Condition-uv-ips This profile represents the constraints applied to the Condition resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of problem is represented in the patient summary as an instance of the Condition resource constrained by this profile.
  • device-uv-ips This profile represents the constraints applied to the Device resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR STU3. A device used by or implanted on the patient is described in the patient summary as an instance of a Device resource constrained by this profile.
  • DeviceUseStatement-uv-ips This profile represents the constraints applied to the DeviceUseStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR STU3. A statement about a device used by or implanted on the patient is described in the patient summary as an instance of a DeviceUseStatement resource constrained by this profile.
  • Device-observer-uv-ips This profile represents the constraints applied to the Device resource by the IPS project, which specifies an international patient summary based on the FHIR standard STU3.; This profile describes a device that plays the role of observer.
  • ImagingStudy-uv-ips This profile represents the contraints applied to the ImagingStudy resource by the IPS project, which specifies the information on a DICOM imaging study this imaging result is part of.
  • Immunization-uv-ips This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party. Two extensions are optionally used by this profile: (1) the first one provides the details about the assertion (e.g. who did the assertion, when was done); (2) The second one provides the list of diseases targeted by this vaccine. The vaccinationProtocol has been removed by this version of the profile as pre-adoption of the R4.
  • Medication-uv-ips This profile represents the constraints applied to the Medication resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR STU3. A medication is described in the patient summary as an instance of a Medication resource constrained by this profile.
  • MedicationStatement-uv-ips This profile represents the constraints applied to the MedicationStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR STU3. A record of a medication statement is represented in the patient summary as an instance of a MedicationStatement resource constrained by this profile.
  • Observation-attachment-uv-ips This profile constrains the Observation resource to the valueAttachment
  • Observation-uv-ips This profile constrains the Observation resource to represent various results in a patient summary, if no other more specific profile applies.
  • Observation-laboratory-uv-ips This profile constrains the Observation resource to represent results produced by laboratory tests or panels/studies in a patient summary. This observation may represent the result of a simple laboratory test such as hematocrite or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and or a global interpretation by the producer of the study, in the comment element; and references the atomic results of the study as "has-member" child observations.
  • Observation-member-pathology-uv-ips This profile constrains the Observation resource to represent a sub-observation, member of an "organizer" observation, in the "athology results entry of a patient summary
  • Observation-member-laboratory-uv-ips This profile constrains the Observation resource to represent a sub-observation, member of an "organizer" observation, in the "Laboratory results" entry of a patient summary
  • Observation-pathology-uv-ips This profile constrains the Observation resource to represent results produced by pathology studies in a patient summary
  • Observation-alcoholUse-uv-ips This profile constrains the Observation resource to represent alcohol use assessment in a patient summary
  • Observation-imaging-uv-ips This profile represents the contraints applied to the Observation resource by the IPS project, which specifies an imaging observation for the international patient summary based on the FHIR standard STU3. This observation may represent the conclusions of a diagnostic procedure such a Chest RX, or it may group the set of results produced by that single or multi modality procedure. In the latter case, the main observation (this one) carries the overall conclusion of the study and/or a global interpretation by the observer of the study as value of this observation; and may references the atomic results of the study as "child observations". It allows also to provide details about the related study using the event-partOf extension referring an ImagingStudy resource.
  • Observation-member-imaging-uv-ips This profile represents the contraints applied to the Observation resource by the IPS project, which specifies a sub-observation, member of an "organizer" observation, in the "Imaging results" entry of a patient summary.
  • Observation-pregnancy-edd-uv-ips This profile constrains the Observation resource to represent the pregnancy expected delivery date.
  • Observation-pregnancy-outcome-uv-ips This profile constrains the Observation resource to represent the history of pregnancy outcomes (summary).
  • Observation-pregnancy-status-uv-ips This profile constrains the Observation resource to represent the pregnancy status.
  • Observation-tobaccoUse-uv-ips This profile constrains the Observation resource to represent Tobacco use assessment in a patient summary
  • organization-laboratory-uv-ips This profile constrains the Organization resource to represent an organization having produced laboratory results for a patient summary. Examples of such organizations include laboratory medicine, public health laboratory, healthcare institution ...
  • Organization-observation-uv-ips This profile constrains the Organization resource to represent an organization involved as performer or observer for these imaging results.
  • Patient-uv-ips This profile represents the constraints applied to the Patient resource by the International Patient Summary (IPS) FHIR Implementation Guide and describes the minimum expectations for the Patient resource when used in the IPS composition or in one of the referred resources.
  • Practitioner-uv-ips This profile constrains the Practictioner resource to represent a practictioner acting as observer for these imaging results.
  • Procedure-uv-ips This profile represents the contraints applied to the Procedure resource by the IPS project, which specifies an entry of the History of Procedure for the international patient summary based on the FHIR standard STU3.
  • specimen-uv-ips This profile constrains the Specimen resource to represent the characteristics of a biological specimens in the context of laboratory results integrated to a patient summary