Quality review summary

Generated Wed Apr 02 14:11:22 CEST 2025, FHIR version 4.0.1 for hl7.fhir.uv.ips#1.1.0 (https://hl7.org/fhir/uv/ips/)

IG Publisher Q/A summaryerrors = 0, warn = 0, info = 0, broken links = 0
Quality checks summary
Domain Check=True Check=False
Pages and organization 6 1
Writing and narrative 5 0
Security and privacy considerations 0 1
Comparison capability statements / narrative summary
item Number of differences
resources 9
interactions 76
search parameters 35

Quality checks

Inspired by IG Best Practices described in Guidance for FHIR IG Creation

domain criteria check proof
Pages and organization Separate display of normative content True Pages: ipsStructure.html, terminology.html, profiles.html, design.html, datatypes.html, principles.html, ipsGeneration.html, extensions.html
Pages and organization Separate display of non-normative content True Pages: downloads.html, toc.html, searchform.html, copyrights.html
Pages and organization Presence of index page True Page: index.html
Pages and organization Presence of toc page True Page: toc.html
Pages and organization Presence of artifacts page True Page: artifacts.html
Pages and organization Presence of background page False No background page
Pages and organization Presence of downloads page True Page: downloads.html
Writing and narrative Index page starts with a patient-friendly explanation of the purpose of the IG True Extract (page index.html): An International Patient Summary (IPS) document is an electronic health record extract containing essential healthcare information about a subject of care.
Writing and narrative Presence of a section that explains key information that needs to be understood prior to reading the IGTrue
  • Extract (page index.html): An International Patient Summary (IPS) document is an electronic health record extract containing essential healthcare information about a subject of care. As specified in EN 17269 and 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.
  • Extract (page principles.html): With the formal agreement signed on April 2017, HL7 International and CEN/TC 251 expressed their intent to collaborate under a set of principles for the IPS. Based on this agreement, the standards specification for the IPS has to be (a) implementable (b) applicable for global use (c) extensible and open to future use cases and solutions. The standards specification and their implementation must be moreover sustainable.
  • Extract (page copyrights.html): This guide, as well the artifacts developed by HL7® including terminologies, is produced by HL7 under the terms of HL7® Governance and Operations Manual relating to Intellectual Property (Section 16), specifically its copyright, trademark and patent provisions.
Writing and narrative Presence an explanation of what "mustSupport" means for different types of implementations of the IG True
  • Extract (page principles.html): With the formal agreement signed on April 2017, HL7 International and CEN/TC 251 expressed their intent to collaborate under a set of principles for the IPS.
  • Extract (page design.html): Implementers conforming to a particular profile in the IPS Implementation Guide: SHALL be capable of producing values for the mustSupport elements in the profile... SHALL be capable of processing resource instances containing mustSupport data elements, including elements with missing data, without generating an error or causing the application to fail.
Writing and narrative Presence of information on how to engage with the community True
  • Extract (page principles.html): Recommendations on operations for IPS generation are included in this guide, although future implementation guides may provide alternative methods and further recommendations different than those outlined.
  • Extract (page design.html): Ongoing FHIR implementations will influence future guidance around the content and display of narrative content, which is required in the IPS Composition. We encourage implementers to monitor this topic and provide feedback through HL7 engagement, issue logging and community discussion.
  • Extract (page extensions.html): Propose a change
  • Extract (page ValueSet-results-radiology-numobs-snomed-dicom-uv-ips.html): Implementers of SNOMED CT should review usage terms or directly contact SNOMED International: info@snomed.org
Writing and narrative Presence of an explanation of the relationship of the IG to any other guides True
  • Extract (page index.html): Further details on the IPS project relationships with other projects and guidelines are available in the IPS Website.
  • Extract (page principles.html): As described also in the IPS CDA implementation guide it is not in the scope of this version of this Implementation Guide to constrain solutions or strategies for the creation, sharing, syntactical and semantic mapping, translation, and use of the IPS.
  • Extract (page design.html): This guide follows the principles described in the IPS CDA implementation guide.
  • Extract (page ipsGeneration.html): Future implementation guides may provide alternative methods and further recommendations for IPS document Bundle generation. These may include methods different than those outlined above. In addition, the International Patient Access Implementation Guide Implementation Guide provides additional guidance accessing individual resources as well as documents from compatible FHIR servers.
  • Extract (page knownIssues.html): Investigate the relationships and the possible synergies with the proposed International Patient Access Implementation Guide; exploring and better clarifying the role of the IPS document and of its reusable components (IPS profiles library).
  • Extract (page profiles.html): All the profiles specified by this guide are used by the International Patient Summary Composition.
  • Extract (page terminology.html): Many of the terminology artifacts specified by this guide are also published in the Art Decor IPS repository.
Security and privacy considerationsPresence of a section focused on security or privacy False

Comparison capability statements / narrative

IpsServerCapabilityStatement

Resource Resource difference Interactions differences Search parameters differences
DocumentReference Not in narrative
OperationDefinitionNot in narrative
DeviceUseStatement Not in narrative
ImagingStudy Not in narrative
Specimen Not in narrative
PractitionerRole Not in narrative
Medication Not in narrative
Media Not in narrative
Composition Not in narrative
MedicationRequest
  • Not in CS: medication, status, patient
Condition
  • Not in CS: code, status, patient
Bundle
  • Not in CS: search-type, create, read
Observation
  • Not in CS: status, code, patient, category
Organization
  • Not in CS: identifier, name
Immunization
  • Not in CS: status, patient, vaccineCode
Patient
  • Not in CS: gender, birthdate, identifier, name
MedicationStatement
  • Not in CS: medication, status, patient
DiagnosticReport
  • Not in CS: status, code, patient
AllergyIntolerance
  • Not in CS: status, code, patient
Procedure
  • Not in CS: status, patient, category
Device
  • Not in CS: status, patient
Practitioner
  • Not in CS: identifier, name