International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Artifact Index

Artifact Index

Templates

Templates for the International Patient Summary.

CDA Document Level Templates

International Patient Summary 2.16.840.1.113883.10.22.1.1 (2020-07-14)

CDA Header Level Templates

IPS CDA Organization 2.16.840.1.113883.10.22.9.1 (2017-04-11)

IPS CDA Person 2.16.840.1.113883.10.22.9.3 (2017-04-12)

IPS CDA author 2.16.840.1.113883.10.22.2.2 (2017-04-11)

IPS CDA custodian 2.16.840.1.113883.10.22.2.3 (2021-08-04)

IPS CDA documentationOf 2.16.840.1.113883.10.22.2.6 (2017-04-12)

IPS CDA legalAuthenticator 2.16.840.1.113883.10.22.2.4 (2017-04-11)

IPS CDA recordTarget 2.16.840.1.113883.10.22.2.1 (2021-09-02)

IPS CDA relatedDocument 2.16.840.1.113883.10.22.2.7 (2017-04-12)

IPS Patient Contacts 2.16.840.1.113883.10.22.2.5 (2017-04-12)

CDA Section Level Templates

IHE Coded Vital Signs Section 1.3.6.1.4.1.19376.1.5.3.1.1.5.3.2 (2015-10-05)

IPS Advance Directives Section 2.16.840.1.113883.10.22.3.12 (2020-05-08)

IPS Allergies and Intolerances Section 2.16.840.1.113883.10.22.3.2 (2016-11-11)

IPS Functional Status Section 2.16.840.1.113883.10.22.3.8 (2020-05-08)

IPS History of Past Illness Section 2.16.840.1.113883.10.22.3.7 (2017-04-12)

IPS History of Pregnancy Section 2.16.840.1.113883.10.22.3.11 (2020-05-07)

IPS History of Procedures Section 2.16.840.1.113883.10.22.3.4 (2017-03-27)

IPS Immunizations Section 2.16.840.1.113883.10.22.3.5 (2017-04-05)

IPS Medical Devices Section 2.16.840.1.113883.10.22.3.6 (2021-10-20)

IPS Medication Summary Section 2.16.840.1.113883.10.22.3.1 (2016-11-11)

IPS Plan of Care Section 2.16.840.1.113883.10.22.3.9 (2020-05-08)

IPS Problems Section 2.16.840.1.113883.10.22.3.3 (2017-02-15)

IPS Results Section 2.16.840.1.113883.10.22.3.14 (2017-04-30)

IPS Social History Section 2.16.840.1.113883.10.22.3.10 (2020-05-10)

IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02)

CDA Entry Level Templates

IPS Advance Directive Observation 2.16.840.1.113883.10.22.4.37 (2020-05-08)

IPS Advance Directive Organizer 2.16.840.1.113883.10.22.4.46 (2020-05-08)

IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)

IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)

IPS Allergy and Intolerance Concern 2.16.840.1.113883.10.22.4.5 (2016-11-11)

IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2016-11-10)

IPS Body Author 2.16.840.1.113883.10.22.4.14 (2017-03-02)

IPS CDA Device 2.16.840.1.113883.10.22.9.2 (2017-04-12)

IPS Certainty Observation 2.16.840.1.113883.10.22.4.19 (2017-03-29)

IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)

IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)

IPS Immunization 2.16.840.1.113883.10.22.4.15 (2017-03-08)

IPS Immunization Medication Information 2.16.840.1.113883.10.22.4.16 (2017-03-08)

IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02)

IPS Laboratory Result Observation 2.16.840.1.113883.10.22.4.13 (2017-03-21)

IPS Manufactured Material 2.16.840.1.113883.10.22.4.3 (2021-08-02)

IPS Medical Device 2.16.840.1.113883.10.22.4.26 (2017-04-11)

IPS Medication Information (detail.html) 2.16.840.1.113883.10.22.4.2 (2016-11-10)

IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2021-09-02)

IPS ObservationMedia 2.16.840.1.113883.10.22.4.23 (2021-09-02)

IPS Pathology Result Observation 2.16.840.1.113883.10.22.4.11 (2017-03-21)

IPS Planned Act 2.16.840.1.113883.10.22.4.39 (2022-07-15)

IPS Planned Encounter 2.16.840.1.113883.10.22.4.40 (2020-05-08)

IPS Planned Immunization 2.16.840.1.113883.10.22.4.47 (2020-05-08)

IPS Planned Observation 2.16.840.1.113883.10.22.4.41 (2020-05-08)

IPS Planned Procedure 2.16.840.1.113883.10.22.4.38 (2020-05-08)

IPS Pregnancy Expected Delivery Date Observation 2.16.840.1.113883.10.22.4.29 (2017-04-13)

IPS Pregnancy Observation 2.16.840.1.113883.10.22.4.36 (2020-05-07)

IPS Pregnancy Outcome Observation 2.16.840.1.113883.10.22.4.28 (2017-04-13)

IPS Pregnancy Status Observation 2.16.840.1.113883.10.22.4.27 (2020-07-14)

IPS Problem Concern Entry 2.16.840.1.113883.10.22.4.7 (2021-08-04)

IPS Problem Entry 2.16.840.1.113883.10.22.4.8 (2021-08-04)

IPS Problem Status Observation 2.16.840.1.113883.10.22.4.20 (2017-03-29)

IPS Procedure Entry 2.16.840.1.113883.10.22.4.17 (2020-07-14)

IPS Radiology Result Observation 2.16.840.1.113883.10.22.4.12 (2017-03-21)

IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2016-11-15)

IPS Result Observation 2.16.840.1.113883.10.22.4.10 (2017-03-02)

IPS Result Organizer 2.16.840.1.113883.10.22.4.9 (2017-03-02)

IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)

IPS Social History Alcohol Use 2.16.840.1.113883.10.22.4.35 (2017-06-29)

IPS Social History Observation 2.16.840.1.113883.10.22.4.48 (2020-05-10)

IPS Social History Tobacco Use 2.16.840.1.113883.10.22.4.34 (2017-06-20)

IPS Specimen Collection 2.16.840.1.113883.10.22.4.30 (2017-04-14)

IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)

IPS Survey Panel 2.16.840.1.113883.10.22.4.42 (2020-05-08)

CDA Template References

UV Use Period 2.16.840.1.113883.10.21.9.1 (2017-05-02)

IPS Address 2.16.840.1.113883.10.22.11 (2018-04-04)

Unconstrained Templates from the original CDA specification

CDA AssignedEntity 2.16.840.1.113883.10.12.153 (2005-09-07)

CDA Organization 2.16.840.1.113883.10.12.151 (2005-09-07)

CDA Person 2.16.840.1.113883.10.12.152 (2005-09-07)

CDA AssignedEntity 2.16.840.1.113883.10.12.153 (2005-09-07)

CDA Author (Body.html) 2.16.840.1.113883.10.12.318 (2005-09-07)

CDA Device 2.16.840.1.113883.10.12.315 (2005-09-07)

CDA Informant (Body.html) 2.16.840.1.113883.10.12.319 (2005-09-07)

CDA Organization 2.16.840.1.113883.10.12.151 (2005-09-07)

CDA Performer (Body.html) 2.16.840.1.113883.10.12.323 (2005-09-07)

CDA Person 2.16.840.1.113883.10.12.152 (2005-09-07)

CDA RelatedEntity 2.16.840.1.113883.10.12.316 (2005-09-07)

Unconstrained Templates from the original Pharamcy CDA specification

UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30)

Unconstrained Templates from IHE

IHE Vital Signs Observation 1.3.6.1.4.1.19376.1.5.3.1.4.13.2 (2016-09-29)

IHE Vital Signs Organizer 1.3.6.1.4.1.19376.1.5.3.1.4.13.1 (2013-12-20)

Value Sets

Value Sets defined for the IPS.

Absent or Unknown Allergies 2.16.840.1.113883.11.22.9 (2017-03-29)

Absent or Unknown Devices 2.16.840.1.113883.11.22.61 (2018-01-27)

Absent or Unknown Immunization 2.16.840.1.113883.11.22.43 (2017-05-24)

Absent or Unknown Medication 2.16.840.1.113883.11.22.15 (2017-04-01)

Absent or Unknown Problems 2.16.840.1.113883.11.22.17 (2017-04-07)

Absent or Unknown Procedures 2.16.840.1.113883.11.22.36 (2017-05-23)

ActStatusActiveCompletedAbortedCancelled 2.16.840.1.113883.11.22.22 (2017-05-02)

ActStatusActiveCompletedAbortedSuspended 2.16.840.1.113883.11.21.2 (2017-03-06)

ActStatusActiveCompletedAbortedSuspended 2.16.840.1.113883.11.22.12 (2017-03-30)

Adverse Reaction Agents 2.16.840.1.113883.11.22.11 (2017-03-29)

All Languages 2.16.840.1.113883.4.642.3.21 (2021-09-02)

Allergy Reaction 2.16.840.1.113883.11.22.3 (2017-02-23)

Allergy or Intolerance Type 2.16.840.1.113883.11.22.2 (2016-12-06)

Allergy-intolerance Criticality 2.16.840.1.113883.11.22.60 (2017-12-14)

CORE Problem List Disorders 2.16.840.1.113883.11.22.5 (2017-02-01)

DRUGActCode 2.16.840.1.113883.11.22.14 (2017-04-01)

IPS Allergy Status Code 2.16.840.1.113883.11.22.42 (2017-05-24)

IPS Allergy Verification Status 2.16.840.1.113883.11.22.62 (2018-02-07)

IPS Allergy or Intolerance Conditions 2.16.840.1.113883.11.22.10 (2017-03-29)

IPS Condition Status Code 2.16.840.1.113883.11.22.24 (2017-05-02)

IPS Condition Verification Status 2.16.840.1.113883.11.22.8 (2017-03-29)

IPS Current Smoking Status 2.16.840.1.113883.11.22.59 (2017-12-14)

IPS Expected Delivery Date Method 2.16.840.1.113883.11.22.20 (2017-04-13)

IPS Healthcare Professional Roles 2.16.840.1.113883.11.22.53 (2017-06-21)

IPS Medical Devices 2.16.840.1.113883.11.22.23 (2018-02-16)

IPS Personal Relationship 2.16.840.1.113883.11.22.54 (2017-07-18)

IPS Pregnancies Summary 2.16.840.1.113883.11.22.21 (2017-04-13)

IPS Pregnancy Status 2.16.840.1.113883.11.22.68 (2018-12-05)

IPS Procedures 2.16.840.1.113883.11.22.35 (2017-05-23)

IPS Results Coded Values Laboratory 2.16.840.1.113883.11.22.46 (2017-05-31)

IPS Results Coded Values Pathology 2.16.840.1.113883.11.22.47 (2017-05-31)

IPS Results Observation 2.16.840.1.113883.11.22.38 (2017-05-23)

IPS Results Observation Laboratory 2.16.840.1.113883.11.22.39 (2017-05-23)

IPS Results Observation Pathology 2.16.840.1.113883.11.22.41 (2017-05-23)

IPS Results Observation Radiology 2.16.840.1.113883.11.22.40 (2017-05-23)

IPS Results Organizer 2.16.840.1.113883.11.22.37 (2017-05-23)

IPS Specimen Type 2.16.840.1.113883.11.22.56 (2017-12-10)

IPS Target Site 2.16.840.1.113883.11.22.55 (2017-10-18)

IPS Vaccines 2.16.840.1.113883.11.22.44 (2017-05-24)

Laterality (qualifier.html) 2.16.840.1.113883.11.22.57 (2017-12-12)

Medicine Active Substances 2.16.840.1.113883.11.22.32 (2017-05-03)

Medicine Doseform 2.16.840.1.113883.11.22.25 (2017-05-03)

Medicine Package 2.16.840.1.113883.11.22.27 (2017-05-03)

Medicine Route of Administration 2.16.840.1.113883.11.22.33 (2017-05-10)

Medicine Strength Denominator 2.16.840.1.113883.11.22.31 (2017-05-03)

Medicine Strength Numerator 2.16.840.1.113883.11.22.30 (2017-05-03)

Problem Severity 2.16.840.1.113883.11.22.18 (2017-04-07)

Problem Type 2.16.840.1.113883.11.22.16 (2017-04-07)

Quantity Units 2.16.840.1.113883.11.22.28 (2017-05-03)

Topographical modifier (qualifier.html) 2.16.840.1.113883.11.22.58 (2017-12-12)

WHO ATC 2.16.840.1.113883.11.22.29 (2017-05-03)

Value Set References

These Value Sets are referenced from other standards.

ActStatus 2.16.840.1.113883.1.11.15933 (2014-03-26)

ActSubstanceAdministrationImmunizationCode 2.16.840.1.113883.1.11.19709 (2014-03-26)

AdministrableDrugForm 2.16.840.1.113883.1.11.14570 (2014-03-26)

Administrative Gender (HL7 V3.html) 2.16.840.1.113883.1.11.1 (2016-06-23)

AdvanceDirectiveTypeCode 2.16.840.1.113883.1.11.20.2 (2016-06-23)

EntityCode 2.16.840.1.113883.1.11.16040 (2014-03-26)

HL7 BasicConfidentialityKind 2.16.840.1.113883.1.11.16926 (2016-06-23)

INDRoleclassCodes 2.16.840.1.113883.11.20.9.33 (2016-06-23)

Medication Time Units (UCUM.html) 2.16.840.1.113883.11.21.1 (2015-04-29)

Mood Code Evn Int Rqo 2.16.840.1.113883.11.21.4 (2018-03-21)

MoodCodeEvnInt 2.16.840.1.113883.11.20.9.18 (2016-06-23)

ObservationInterpretation 2.16.840.1.113883.1.11.78 (2017-12-17)

ParticipationFunction 2.16.840.1.113883.1.11.10267 (2016-06-23)

ParticipationMode 2.16.840.1.113883.1.11.16543 (2014-03-26)

PersonalRelationshipRoleType 2.16.840.1.113883.1.11.19563 (2014-03-26)

PostalAddressUse 2.16.840.1.113883.1.11.10637 (2005-05-01)

RoleClassIngredientEntity 2.16.840.1.113883.1.11.10430 (2014-03-26)

RoleClassMutualRelationship 2.16.840.1.113883.1.11.19316 (2014-03-26)

RoleStatus 2.16.840.1.113883.1.11.15999 (2014-03-26)

SeverityObservationCode 2.16.840.1.113883.1.11.20386 (2014-03-26)

Social History Type 2.16.840.1.113883.3.88.12.80.60 (2008-12-18)

TelecommunicationAddressUse 2.16.840.1.113883.1.11.201 (2014-03-26)

TimingEvent 2.16.840.1.113883.1.11.10706 (2014-03-26)

VitalSignsObservation_code 1.3.6.1.4.1.19376.1.5.3.1.11.4 (2016-09-29)

x_ActRelationshipEntry 2.16.840.1.113883.1.11.19446 (2014-03-26)

x_ActStatusActiveComplete 2.16.840.1.113883.1.11.19890 (2014-03-26)

x_ServiceEventPerformer 2.16.840.1.113883.1.11.19601 (2017-03-24)

Data Types

PageData types for element definitions used

  • AD – Address
  • AD.IPS – IPS Address (see [1])
  • ANY – ANY
  • BL – Boolean
  • CD – Concept Descriptor
  • CD.IPS – IPS CD (see [2])
  • CE – Coded with Equivalents
  • CE.IPS – IPS CE (see [3])
  • CR – Concept Role
  • CS – Coded Simple Value
  • CV – Coded Value
  • CV.IPS – IPS CV (see [4])
  • ED – Encapsulated Data
  • EIVL.event – Event-Related Interval of Time
  • EIVL_TS – Event-related time interval
  • EN – Entity Name
  • ENXP – Entity Name Part
  • II – Instance Identifier
  • INT – Integer
  • IVL_PQ – Interval of Physical Quantity
  • IVL_TS – Interval of Time Stamp
  • IVL_TS.IPS.TZ – IPS IVL Time Stamp TZ (see [5])
  • IVL_TS.IPS.TZ.OPT
  • IVXB_TS – Interval Boundary of Time Stamp
  • ON – Organization Name
  • PIVL_TS – Periodic Interval of Timezone
  • PN – Person Name
  • PQ – Physical Quantity
  • SC – String with Codes
  • SD.TEXT – Structured Document Text
  • ST – Character String
  • SXPR_TS – Parenthetic Set Expression of Time Stamp
  • TEL – Telecommunication Address
  • TEL.IPS – IPS TEL (see [6])
  • TS – Time Stamp
  • TS.IPS.TZ – IPS Time Stamp TZ (see [7])

Data types for attributes used

  • bl – boolean code
  • cs – code
  • oid – identifier
  • set_cs – code
  • st – string
  • uid – identifier

Extensions

Detailed medications information

This specification uses CDA extensions in order to provide details about medications, as further described in the section on the design conventions for Medicinal Product Identification and as used in template 2.16.840.1.113883.10.22.4.3 IPS Manufactured Material. The extension uses the namespace urn:hl7-org:pharm.

This is the list of elements defined for that template.

  • pharm:formCode (Administrable Pharmaceutical Dose Form)
  • pharm:asContent (Packaging of the medication)
    • pharm:quantity
    • pharm:containerPackagedMedicine (Most inner Package Item or the Packaged Medicinal Product)
      • pharm:code
      • pharm:name (Name of the Package Item or of the Packaged Medicinal Product)
      • pharm:formCode (type of the most inner package item or of the or the Packaged Medicinal Product)
      • pharm:capacityQuantity (the functional capacity of the container)
      • pharm:asContent (Containing package)
        • pharm:quantity
        • pharm:containerPackagedMedicine (Intermediate Package Item or the Packaged Medicinal Product)
          • pharm:code
          • pharm:name (Name of the Package Item or of the Packaged Medicinal Product)
          • pharm:formCode (type of the intermediate package item or of the or the Packaged Medicinal Product)
          • pharm:capacityQuantity (the functional capacity of the container)
          • pharm:asContent (Containing package)
            • pharm:quantity
            • pharm:containerPackagedMedicine (Packaged Medicinal Product)
              • pharm:code
              • pharm:name (Name of the Packaged Medicinal Product)
              • pharm:formCode (type of the Packaged Medicinal Product)
              • pharm:capacityQuantity (the functional capacity of the container)
  • pharm:asSpecializedKind (used to represent any classification of the product (ATC code, future PhPIDs,..) )
    • pharm:generalizedMaterialKind
      • pharm:code
      • pharm:name
  • pharm:ingredient (list of active substances used for this product)
    • pharm:quantity (strength)
    • pharm:ingredientSubstance (active substance)
      • pharm:code
      • pharm:name

Translation of designations

This specification recommends the introduction of an optional extension for properly recording multilingual designations, that is further described in the section on the translation of designations

  • ips:designation