xShare Project Yellow Button
0.2.0-ci-build - ci-build 150

xShare Project Yellow Button, published by xShare Project. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/xShare/ and changes regularly. See the Directory of published versions

Get Started with the xShare Yellow Button One-time Share

This is a brief guideline on why and how to implement the xShare Yellow Button One-time Share feature in your system, and prove its conformance.

To use the Yellow Button Label you have to:

Why the Yellow Button?

  • Enhance your system by offering natural persons a tool to easily access their data in a shareable and standardized format.
  • Comply with the EHDS regulation.

What You Should Be Able to Do

Given that your system manages Natural Person authentication in accordance with European Regulations , the following functionality should be provided:

  • Your system enables the authenticated Natural Person (data owner) to:
    • View and select from the available health data to share.
    • Optionally configure share options (e.g., format, translations, pseudonymization, etc.).
    • Generate the Smart Health Link with the selected content.
    • Provides the Smart Health Link to the Natural Person.
  • Your system enables the authorised data recipient to:
    • View the shared data authorised by the Natural Person when accesses the Smart Health Link.

A detailed diagram is available here.

How to Implement: the specifications

For this version of the xShare Yellow Button the technical specifications to prove conformance with are the content specifications and the Smart Health Link specifications.

Content specifications

Acting as xShare Yellow Button Content Creator and xShare Yellow Button Content Consumer:

  xBundle HL7 FHIR IG
Patient Summary icon Patient Summary HL7 International Patient Summary FHIR IG v2.0.0
Laboratory Report icon Laboratory Report HL7 Europe Laboratory Report FHIR IG v0.1.1
MyHealth@EU Laboratory Report icon MyHealth@EU Laboratory Report MyHealth@EU Laboratory Report FHIR IG v0.1.1

Early implementers might be interested in

(a) piloting the following 'frozen' specifications

  xBundle HL7 FHIR IG
Hospital Discharge Report icon Hospital Discharge Report HL7 Europe Hospital Discharge Report FHIR IG v0.1.0-ballot
Medicine Prescription and Dispense icon Medicine Prescription and Dispense HL7 EU Medication Prescription and Dispense FHIR IG v0.1.0-ballot
Imaging Report icon Imaging Report HL7 EU Imaging Report FHIR IG v0.1.0-snapshot1
Imaging Report icon Imaging Study Manifest IHE Manifest-based Access to DICOM Objects (MADO) v0.6

(a) trying the following on development specification

  xBundle HL7 FHIR IG
Patient Summary icon Patient Summary HL7 Europe Patient Summary FHIR IG (0.1.0-ci-build)

Acting as xShare Yellow Button Link Provider:

Acting as xShare Yellow Button Link Consumer:

Declare and Prove Your Conformance

Claim Your Conformance

To claim conformance with the xShare Yellow Button One-time Share, implementers must issue a conformance statement specifying the content specifications and the optional features supported (e.g. additional download formats, password protected content, psuedoanonymized data;…).

Prove Your Conformance

To prove conformance to the xShare Yellow Button One-time as xShare Yellow Button Provider you must:

  1. Demonstrate that only authenticated Natural Persons can access the xShare Yellow Button One-time Share feature.
  2. Claim that user autentication is realized in conformance with the European Regulations
  3. Demonstrate that (only) authenticated Natural Persons can search for and select the documents or data they wish to share.
  4. Demonstrate that a valid Smart Health Link is generated.
  5. Ensure that content authorised for sharing (the SHL Manifest) is available in the selected target format when the authorised data recipient accesses the Smart Health Link.
  6. The SHL Manifest passes the validation tests for each of the declared supported content specifications (e.g., Patient Summary, Laboratory Results), as listed in the Yellow Button Information view page.

To prove conformance to the xShare Yellow Button One-time as xShare Yellow Button Consumer you must:

  1. Ensure that is able to process a valid Smart Health Link.
  2. Demonstrate that can accesses the content authorised for sharing (the SHL Manifest), available in the selected target format.
  3. Show that is able to 'consume' (e.g. display, import,…) any of the declared supported content specifications (e.g., Patient Summary, Laboratory Results), as listed in the Yellow Button Information view page.

Label Your System

To label your system follow the labeling process.