This wiki has undergone a migration to Confluence found Here

Difference between revisions of "201805 International Patient Summary"

From HL7Wiki
Jump to navigation Jump to search
Line 9: Line 9:
<!-- Who is asking for this track? -->
<!-- Who is asking for this track? -->
* Structured Documents WG
* Structured Documents WG
* FHIR Product Director
* IPS Project
* IPS Project

Revision as of 10:28, 5 April 2018

International Patient Summary

This track will test the creation and exchange of FHIR International Patient Summary (IPS) documents (using a document Bundle resources containing a Composition and other supporting resources). We anticipate working closely with the FHIR Documents track.

Submitting WG/Project/Implementer Group

  • Structured Documents WG
  • FHIR Product Director
  • IPS Project


The FHIR version of the International Patient Summary (IPS) is being newly balloted in this cycle ( The primary use case envisioned for the IPS specification is the cross-border, unscheduled care of a patient, and the Connectathon and WGM in Cologne, Germany provide an opportunity to test and begin to obtain implementation of this specification in a European setting where cross-border (and cross-language) considerations are especially relevant for the delivery of heath care services.

Proposed Track Lead

See Connectathon_Track_Lead_Responsibilities

Expected participants

  • Rob Hausam
  • Francois Macary
  • Others TBD


IPS Document Creator

Creates a FHIR IPS document (Bundle containing a Composition and supporting resources) from source data. The source data likely will be existing data on a FHIR server, but this can be done using whatever means are appropriate, including manual creation, assembling documents from other resources, transforming from a CDA IPS document, etc. Submits that document to a FHIR server. Optionally a document creator may digitally sign the document (but this is not expected at this time).

IPS Document Consumer

Retrieves a FHIR IPS document created by the Document Creator from the FHIR server and does one or more of the following: a) validates the document against the IPS Clinical Document profile, b) displays the document in a browser (or by other means), c) translates the coded and/or narrative data to a different language for display, or d) translates the coded data to different code system(s) used in a jurisdiction that is different from the source.


For all scenarios below, participants are expected to provide their own content for the documents (obviously nothing with PHI should be used at a public Connectathon). If participants don't have readily available content, they are encouraged to create documents that mimic the content in Consolidated CDA sample files.

1. Create an IPS document

Action: User creates a FHIR IPS document consisting of a Composition resource with narrative sections, bundled with Patient (Composition.subject) and Practitioner ( and the additional supporting resources containing the summary clinical data. User then POSTs the document to a FHIR server.
Precondition: none, but existing resources may be used.
Success Criteria: Bundle is successful submitted to a FHIR server. Consumer in Scenario 4 can display the document and render all attested content.

Basic script:

  • Step 1: Create a Composition resource
  • Step 2: Ensure the subject, author, and custodian references point to valid Patient, Practitioner, and additional clinical resources .
  • Step 3: POST the Composition to a FHIR server
  • Step 4: Check the operation outcome to ensure it was successful
  • Step 5: Call $document on the Composition (if supported by the server) to get a full document Bundle back, or create the Bundle through other means (custom code, etc.)

2. Display an IPS document

Action: User retrieves an IPS document from the FHIR server and displays it in a web browser (or by other means).
Precondition: An IPS document exists on the target FHIR server.
Success Criteria: Document is successfully displayed.

3. Translate the narrative and coded data into different language(s) for display or to other code systems appropriate for different jurisdictions (as in c, d above).


Security and Privacy Considerations