xShare Project Yellow Button
0.1.0 - trial-use 150

This page is part of the xShare Project Yellow Button Implementation Guide (v0.1.0: Release 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Yellow Button Application view

The application domain describes what are the logical (software) components involved in the yellow button business processes and how they interact, collaborate or are coordinated.

In this version a sequence diagram is used to describe how - from an application perspective - the business process is realized.

An overview of the Primary logical application components considered in the design of the xShare reference implementation is also provided.

The Yellow Button Participants

In the sequence diagram documented in the next section the following participants are higlighted:

  • the Natural Person : the human actor managing the process. Not in scope for the YB labeling process.
  • The xShare Yellow Button : the component enabling the natural person to download and share the health data. In scope for the YB labeling process.
  • The Authorised Data Recipient : the component consuming the health data shared by the natural person. In scope for the YB labeling process.
  • The Natural Person's Storage : the component where the health data are stored after the download. Not in scope for the YB labeling process.

Sequence diagrams

For each of the identified Yellow Button capabilities a sequence diagrams is reported:

Download

The download functionality enables the citizen to download their health data (in the EEHRxF machine readable format and optionally also human readable format, e.g., PDF) with a click-of-a-button, from a health provider portal/app to their computer or smartphone, according to the following workflow:

xShare Yellow ButtonxShare Yellow ButtonNatural PersonxShare Yellow ButtonNatural Person's StorageNatural PersonNatural PersonxShare Yellow ButtonxShare Yellow ButtonNatural Person's StorageNatural Person's StoragexShare Yellow ButtonxShare Yellow ButtonNatural Person authentication (pre-condition)"Natural Person Authentication"Natural Person Authenticates in the user interfaceSearch and Select Health InformationSearch and Select Natural Person's Health dataSearch Natural Person's Health DataSearch Natural Person's Health Data: Shows Natural Person's available Health DataSelects health data to download or shareRetrieve and Format Health InformationRetrieve and Format Natural Person's Health dataRetrieve Natural Person's Health DataEEHRxF dataSelects Data Transformation Optionopt[select Data Transformation option]Selects transformation option (human-readable format,anonymisation, password protection, translation, digital signature)Transformed dataDownload Health InformationDownload Natural Person's Health InformationDownloads Natural Person's Health DataNatural Person's Health Information is stored

One-time share

The one-time share (consent) functionality enables the citizen to consent and share their health data (in the EEHRxF) with a click-of-a-button, from a health provider portal/app to a trusted one (e.g., healthcare provider, relative, or a third-party health app), according to the following workflow:

xShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonAuthorised Data RecipientNatural PersonxShare Yellow ButtonAuthorised Data RecipientNatural PersonNatural PersonxShare Yellow ButtonxShare Yellow ButtonAuthorised Data RecipientAuthorised Data RecipientxShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonAuthorised Data RecipientNatural Person authentication (pre-condition)Natural Person AuthenticationNatural Person Authenticates in the user interfaceSearch and Select Health InformationSearch and Select Natural Person's Health dataSearch Natural Person's Health DataSearch Natural Person's Health Data: Shows Natural Person's available Health DataSelects health data to download or shareRetrieve and Format Health InformationRetrieve and Format Natural Person's Health dataRetrieve Natural Person's Health DataEEHRxF dataSelects Data Transformation Optionopt[select Data Transformation option]Selects transformation option (human-readable format,anonymisation, password protection, translation, digital signature)Transformed dataOne-time Share Health DocumentOne-time ShareOne-time share Natural Person's Health DataSmart Health Link GeneratedShows Smart Health LinkShares Smart Health LinkAccesses Smart Health LinkAccesses and can download Health Data

Linked option

The linked option functionality enables the citizen to share their health data (in the EEHRxF) with a click-of-a-button, from a health provider portal/app to a trusted one (e.g., healthcare provider, relative, clinical trials, research institutions) for a period of time, according to the following workflow:

xShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonAuthorised Data RecipientNatural PersonxShare Yellow ButtonAuthorised Data RecipientNatural PersonNatural PersonxShare Yellow ButtonxShare Yellow ButtonAuthorised Data RecipientAuthorised Data RecipientxShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonxShare Yellow ButtonAuthorised Data RecipientNatural Person authentication (pre-condition)Natural Person AuthenticationNatural Person Authenticates in the user interfaceSearch and Select Health InformationSearch and Select Natural Person's Health dataSearch Natural Person's Health DataSearch Natural Person's Health Data: Shows Natural Person's available Health DataSelects health data to download or shareRetrieve and Format Health InformationRetrieve and Format Natural Person's Health dataRetrieve Natural Person's Health DataEEHRxF dataSelects Data Transformation Optionopt[select Data Transformation option]Selects transformation option (human-readable format,anonymisation, password protection, translation, digital signature)Transformed dataLinked Options Health DocumentLinked OptionsOne-time share Natural Person's Health DataSmart Health Link Generated (flag L: long-term)Shows Smart Health LinkShares Smart Health LinkAccesses Smart Health LinkUpdates Natural Person's Health DataAccesses and can download Health Data

Declare and Prove Your Compliance

Claim Your Compliance

To claim compliance the application level rules specified in this page, xShare Yellow Button implementers must issue a conformance statement in accordance with the indications of the Claim Your Conformance section.

Prove Your Compliance

To prove compliance the application level rules specified in this page, xShare Yellow Button implementers must be able to demostrate that thier solutions are conformant with what is specified in the Prove Your Conformance section.