International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
IPS Server Capability Statement |
This section describes the expected capabilities of the IPS Server actor which is responsible for providing responses to the queries submitted for IPS documents. The list of FHIR profiles and operations supported by IPS Servers are defined. |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
IPS Summary |
This operation is used to return a patient summary using the IPS profile. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
AllergyIntolerance (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. |
Bundle (IPS) |
This profile represents the constraints applied to the Bundle resource by the International Patient Summary (IPS) FHIR Implementation Guide. |
Composition (IPS) |
Clinical document used to represent the International Patient Summary (IPS) data set. An International Patient Summary (IPS) document is an electronic health record extract containing essential healthcare information about a subject of care. The IPS dataset is minimal and non-exhaustive; specialty-agnostic and condition-independent; but still clinically relevant. As specified in ISO 27269, it is designed for supporting the use case scenario for ‘unplanned, cross border care’, but it is not limited to it. It is intended to be international, i.e., to provide generic solutions for global application beyond a particular region or country. |
Condition (IPS) |
This profile represents the constraints applied to the Condition resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of a problem is represented in the patient summary as an instance of the Condition resource constrained by this profile. |
Device (IPS) |
This profile represents the constraints applied to the Device resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. 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. |
Device - Performer or Observer (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 R4.; This profile describes a device that plays the role of observer or performer. |
DeviceUseStatement (IPS) |
This profile represents the constraints applied to the DeviceUseStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. 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. |
DiagnosticReport (IPS) |
This profile constrains the DiagnosticReport resource to represent diagnostic test and procedure reports in a patient summary. |
Flag - Alert (IPS) |
This profile constrains the Flag resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an alert is represented in the patient summary as an instance of a Flag resource constrained by this profile. This specialized Flag is used to convey information about an alert specific to an IPS. Information is flagged to raise awareness of potential concerns and/or dangers to/from the subject of the IPS. It brings information to the fore and may reference other information from the summary (through the supportingInfo extension) as well as present obstacles to care. |
ImagingStudy (IPS) |
This profile represents the constraints 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 (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. |
Medication (IPS) |
This profile represents the constraints applied to the Medication resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A medication is described in the patient summary as an instance of a Medication resource constrained by this profile. |
MedicationRequest (IPS) |
This profile represents the constraints applied to the MedicationRequest resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A record of a medication request is represented in the patient summary as an instance of a MedicationRequest resource constrained by this profile. |
MedicationStatement (IPS) |
This profile represents the constraints applied to the MedicationStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A record of a medication statement is represented in the patient summary as an instance of a MedicationStatement resource constrained by this profile. |
Observation Pregnancy - Expected Delivery Date (IPS) |
This profile constrains the Observation resource to represent the pregnancy expected delivery date (EDD). |
Observation Pregnancy - Outcome (IPS) |
This profile constrains the Observation resource to represent the summarized history of pregnancy outcomes. |
Observation Pregnancy - Status (IPS) |
This profile constrains the Observation resource to represent the pregnancy status. |
Observation Results - Laboratory/Pathology (IPS) |
This profile constrains the Observation resource to represent results produced by laboratory (including pathology) tests or panels/studies in a patient summary. This observation may represent the result of a simple laboratory test such as hematocrit 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 Results - Radiology (IPS) |
This profile represents the constraints applied to the Observation resource by the IPS project, which specifies a radiology observation for the international patient summary based on the FHIR standard R4. 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 reference the atomic results of the study as "child observations". It allows also providing details about the related study using the partOf element referring to an ImagingStudy resource. |
Observation Social History - Alcohol Use (IPS) |
This profile constrains the Observation resource to represent alcohol use assessment in a patient summary. |
Observation Social History - Tobacco Use (IPS) |
This profile constrains the Observation resource to represent Tobacco use assessment in a patient summary. |
Organization (IPS) |
This profile constrains the Organization resource to represent an organization that acts as performer or observer for a result observation (laboratory, pathology or imaging), or as performer for a procedure. |
Patient (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 (IPS) |
This profile constrains the practitioner resource to represent a practitioner acting as observer for these imaging results. |
PractitionerRole (IPS) |
This profile constrains the PractitionerRole resource to represent a practitioner acting as observer for observation results for a specified organization. |
Procedure (IPS) |
This profile represents the constraints 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 R4. |
Specimen (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. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
Codeable Concept (IPS) |
This profile represents the constraint applied to the CodeableConcept data type by the International Patient Summary (IPS) FHIR Implementation Guide to use the Coding-uv-ips data type profile. |
Coding with translations |
This profile extends the capabilities of the coding data type to support multi-language designations (display). It relies on the Translation extension. |
Quantity (IPS) |
Data type Quantity constrained to use UCUM as the code system for units |
Range (IPS) |
Range constrained to UCUM as the code system for units. |
Ratio (IPS) |
Ratio data type, constrained to use UCUM as the code system for units. |
SimpleQuantity (IPS) |
Data type profile SimpleQuantity constrained to use UCUM as the code system for units |
These define sets of codes used by systems conforming to this implementation guide.
Allergy Intolerance - IPS |
IPS Allergy intolerance codes value set. This value set includes codes from SNOMED CT®: all descendants of 373873005 |Pharmaceutical / biologic product (product)|; all descendants of 105590001 |Substance (substance)|; all descendants of 420134006 |Propensity to adverse reaction (finding)|; all descendants or self of 716186003 |No known allergy (situation)| SNOMED CT® ECL definition: |
Allergy Reaction - IPS |
IPS allergy reaction value set. This value set includes a set of SNOMED CT codes and descendants (all top level codes are included in the SNOMED CT IPS Terminology) that may be used to represent allergy or intolerance reactions. SNOMED CT® ECL definition: |
Body Site - IPS |
IPS body site value set. This value set includes a set of codes from SNOMED CT that may be used to represent body sites (e.g., for laboratory specimen collection). This value set includes codes from SNOMED CT®: all descendants of 442083009 |Anatomical or acquired body structure (body structure)| SNOMED CT® ECL definition: |
Current Smoking Status - IPS |
HL7 IPS SNOMED value set for smoking status. This value set includes a set of specific SNOMED CT codes (no subtypes included) that may be used to represent smoking status. SNOMED CT® ECL definition: |
Diagnostics Report Status Codes - IPS |
IPS Diagnostic Report status codes allowable for diagnostics reports. This value set includes all status codes except "entered-in-error" from http://hl7.org/fhir/diagnostic-report-status. |
Healthcare Professional Roles - IPS |
IPS Healthcare Professional Roles |
Imaging Study Status Codes - IPS |
IPS Imaging Study status codes allowable for results. section This value set includes all imaging study status codes except "entered-in-error" from http://hl7.org/fhir/imagingstudy-status. |
Medical Devices - IPS |
IPS Medical device codes value set. This value set includes codes from SNOMED CT (SNOMED CT®) that are included in: all descendants of 49062001 |Device (physical object)|; all descendants or self of 787483001 |No known device use (situation)| SNOMED CT® ECL definition: |
Medications - IPS |
IPS Medication codes value set. This value set includes codes from SNOMED CT®: all descendants of 763158003 |Medicinal product (product)|; excluding the descendants or self of 787859002 |Vaccine product (medicinal product)|; including all descendants or self of 787481004 |No known medications (situation)| SNOMED CT® ECL definition: |
Medications - example (IPS) |
This value set provides an example of possible medication coded concepts. This value set will be removed in a future release and has been replaced with medication-uv-ips. |
Medicine Active Substances - IPS |
IPS Medicine active substance codes value set. This value set includes codes from SNOMED CT®: all descendants of 410942007 |Drug or medicament (substance)| SNOMED CT® ECL definition: Future implementations should consider ISO 11238 Health informatics – Identification of medicinal products – Data elements and structures for the unique identification and exchange of regulated information on substances. |
Medicine Doseform - IPS |
EDQM (European Directorate for the Quality of Medicines and Healthcare) Dose Form codes. This Value Set includes all the EDQM Standard Terms having: PDF = 'Pharmaceutical dose form'; CMT = 'Combined terms'; CDF = 'Combined pharmaceutical dose form'; PFT = 'Patient Friendly' |
Medicine Route of Administration - IPS |
EDQM (European Directorate for the Quality of Medicines and Healthcare) Route of Administration codes. This Value Set includes all the EDQM Standard Terms having: ROA = 'Route of administration' |
Personal Relationship - IPS [Deprecated] |
The Value Set is used (optionally) to code the type of contact relationship between a person and the patient. This value set has been deprecated and will be removed in a future release. It has been replaced with PersonalRelationshipRoleType |
Pregnancy Expected Delivery Date Method - IPS |
IPS Expected Delivery Date Method |
Pregnancy Outcome - IPS |
IPS Pregnancies Summary |
Pregnancy Status - IPS |
IPS pregnancy status codes value set. This value set includes codes from SNOMED CT®: 77386006 |Pregnant|; 60001007 |Not pregnant|; 152231000119106 |Pregnancy not yet confirmed|; 146799005 |Possible pregnancy| SNOMED CT® ECL definition: |
Problem Type (LOINC) |
This value set indicates the level of medical judgment used to determine the existence of a problem. |
Problem Type - IPS |
This value set provides a category for the condition as a clinical problem for inclusion in the patient summary. |
Problems - IPS |
IPS Problem (Condition) codes value set. This value set includes codes from SNOMED CT®: all descendants of 404684003 |Clinical finding (finding)|; all descendants of 243796009 |Situation with explicit context (situation)|; all descendants of 272379006 |Event (event)|; all descendants or self of 160245001 |No current problems or disability (situation)|. The descendants of 71388002 |Procedure (procedure)| (which were included in the CORE problem list) are not included, as they are expected to be represented separately in the History of Procedures Section. SNOMED CT® ECL definition: |
Procedures - IPS |
IPS Procedure codes value set. This value set includes codes from SNOMED CT®: all descendants of 71388002 |Procedure (procedure)|; excluding [all descendants or self of 14734007 |Administrative procedure (procedure)|; all descendants or self of 59524001 |Blood bank procedure (procedure)|; all descendants or self of 389067005 |Community health procedure (procedure)|; all descendants or self of 442006003 |Determination of information related to transfusion (procedure)|; all descendants or self of 225288009 |Environmental care procedure (procedure)|; all descendants or self of 308335008 |Patient encounter procedure (procedure)|; all descendants or self of 710135002 |Promotion (procedure)|; all descendants or self of 389084004 |Staff related procedure (procedure)|]; including all descendants or self of 787480003 |No known procedures (situation)| SNOMED CT® ECL definition: |
Results Coded Values Laboratory/Pathology - IPS |
IPS Results Coded Values Laboratory/Pathology value set. This value set includes codes from SNOMED CT®: all descendants of 365636006 |Finding of blood group (finding)|; all descendants of 260411009 |Presence findings (qualifier value)|; all descendants of 272519000 |Absence findings (qualifier value)|; all descendants of 409822003 |Domain Bacteria (organism)|; all descendants of 441649000 |Class Cestoda and/or Class Trematoda and/or Phylum Nemata (organism)|; all descendants of 414561005 |Kingdom Fungi (organism)|; all descendants of 84676004 |Prion (organism)|; all descendants of 49872002 |Virus (organism)|; all descendants of 417396000 |Kingdom Protozoa (organism)|; all descendants of 419036000 |Domain Archaea (organism)|; all descendants of 426785004 |Kingdom Chromista (organism)|; all descendants of 370570004 |Kingdom Protoctista (organism)|; all descendants of 417377004 |Kingdom Viridiplantae (organism)|; all descendants of 243565002 |Slime mold (organism)|; all descendants of 106253005 |Histologic grading differentiation AND/OR behavior (qualifier value)|; all descendants of 373369003 |Finding of histologic grading differentiation AND/OR behavior (finding)|; all descendants of 399981008 |Neoplasm and/or hamartoma (disorder)| SNOMED CT® ECL definition: |
Results Laboratory/Pathology Observation - IPS |
Value Set Definition: LOINC {STATUS in {ACTIVE}, CLASSTYPE in {Laboratory class (1)}, CLASS exclude {LP62148-9 (NR STATS), LP175679-2 (H&P.HX.LAB), LP7785-1 (CHALSKIN), LP94892-4 (LABORDERS)}} |
Results Radiology Measurement Observation - IPS |
Extensible value set including SNOMED CT and DICOM concepts for Linear, Area and Volume Measurements |
Results Radiology Observation - IPS |
Value Set Definition: LOINC {STATUS in {ACTIVE}, CLASS in LP29684-5 ("RAD")} |
Results Radiology Textual Observation - IPS |
IPS Results Radiology Textual Observation |
Results Specimen Collection Method - IPS |
IPS Specimen collection method codes value set. This value set includes codes from SNOMED CT®: all descendants or self of 129316008 |Aspiration - action (qualifier value)|; all descendants or self of 129314006 |Biopsy - action (qualifier value)|; all descendants or self of 129300006 |Puncture - action (qualifier value)|; all descendants or self of 129304002 |Excision - action (qualifier value)|; all descendants or self of 129323009 |Scraping - action (qualifier value)|; all descendants or self of 73416001 |Urine specimen collection, clean catch (procedure)|; all descendants or self of 225113003 |Timed urine collection (procedure)|; all descendants or self of 70777001 |Urine specimen collection, catheterized (procedure)|; all descendants or self of 386089008 |Collection of coughed sputum (procedure)|; all descendants or self of 278450005 |Finger-prick sampling (procedure)| SNOMED CT® ECL definition: |
Results Specimen Type - IPS |
IPS Specimen Type codes value set. This value set includes codes from SNOMED CT®: all descendants of 123038009 |Specimen (specimen)| SNOMED CT® ECL definition: |
Results Status Codes - IPS |
IPS Observation status codes allowable for results. This value set includes all observation status codes except "entered-in-error" from http://hl7.org/fhir/observation-status. |
Vaccine Target Diseases - IPS |
IPS Vaccine target disease codes value set. This value set includes codes from SNOMED CT that represent specific vaccine target diseases (descendant concepts, if they exist, are not included). SNOMED CT® ECL definition: |
Vaccines - IPS |
IPS Vaccine codes value set. This value set includes codes from SNOMED CT®: all descendants of 787859002 |Vaccine product (product)|; all descendants or self of 787482006 |No known immunizations (situation)| SNOMED CT® ECL definition: |
Vaccines WHO ATC - IPS |
IPS Vaccine codes value set. This value set includes codes from the World Health Organization Anatomical Therapeutic Chemical (ATC) classification system: all descendants of J07 "VACCINES" |
WHO ATC - IPS |
World Health Organization Anatomical Therapeutic Chemical (ATC) classification system. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
AllergyIntolerance - Multiple Codings |
AllergyIntolerance - Multiple Codings |
AllergyIntolerance - No Known Allergies |
AllergyIntolerance - No Known Allergies |
AllergyIntolerance - Resolved Allergy |
AllergyIntolerance - Resolved Allergy |
Bundle - IPS with Data |
Bundle - IPS with Data |
Bundle - IPS with Required Sections and Immunization |
Bundle - IPS with Required Sections and Immunization |
Bundle - Minimal Complete IPS |
Bundle - Minimal Complete IPS |
Bundle - No Information in Required Sections |
Bundle - No Information in Required Sections |
Composition - Minimal Sections |
Composition - Minimal Sections |
Condition - Acute Myeloid Leukemia |
Condition - Acute Myeloid Leukemia |
Device - Device Observer |
Device - Device Observer |
Device - No Known Devices in Use |
Device - No Known Devices in Use |
DeviceUseStatement - No Known Devices in Use |
DeviceUseStatement - No Known Devices in Use |
DiagnosticReport - Hemoglobin |
DiagnosticReport - Hemoglobin |
Flag - Alert of Patient Immunocompromised |
Flag - Alert of Patient Immunocompromised |
ImagingStudy - Referred DICOM Study |
ImagingStudy - Referred DICOM Study |
Immunization - Vaccin anti diphtérie-coqueluche-tétanos-poliomyélite (Luxembourg) |
Immunization - Vaccin anti diphtérie-coqueluche-tétanos-poliomyélite (Luxembourg) |
Medication - Simvastatin 40 MG Disintegrating Oral Tablet |
Medication - Simvastatin 40 MG Disintegrating Oral Tablet |
MedicationRequest - Simvastatin Request |
MedicationRequest - Simvastatin Request |
MedicationStatement - Ongoing Simvastatin Treatment |
MedicationStatement - Ongoing Simvastatin Treatment |
Observation - Social History Alcohol Use |
Observation - Social History Alcohol Use |
Observation: SH tobacco use example |
Observation: SH tobacco use example |
Observation: estrogen receptor in tissue example |
Observation: estrogen receptor in tissue example |
Observation: hemoglobin example |
Observation: hemoglobin example |
Observation: imaging CT Abdomen W contrast IV |
Observation: imaging CT Abdomen W contrast IV |
Observation: imaging CT Abdomen W contrast IV, sub-observations |
Observation: imaging CT Abdomen W contrast IV,sub-observations |
Observation: imaging Chest X-ray - PA and lateral, with additional sub-observation including numeric range |
Observation: imaging Chest X-ray - PA and lateral, with additional sub-observation including numeric range |
Observation: pregnancy edd example |
Observation: pregnancy edd example |
Observation: pregnancy outcome example |
Observation: pregnancy outcome example |
Observation: pregnancy status example |
Observation: pregnancy status example |
Observation: serum creatinine example |
Observation: serum creatinine example |
Observation: urine wbc range example |
Observation: urine wbc range example |
Organization - Minimal Name Only |
Organization - Minimal Name Only |
Organization: example |
Organization: example |
Organization: lab example |
Best Hospital Lab Organization example |
Patient: female patient |
Patient: female patient |
Patient: male patient |
Patient: male patient |
Patient: minimal example |
Patient: minimal example |
Practitioner example |
Practitioner example |
PractitionerRole - Minimal |
PractitionerRole - Minimal |
Procedure: Surgical procedure |
Procedure: Surgical procedure |
Specimen: example |
Specimen: example |