xShare Project Yellow Button
0.1.0 - trial-use 150

xShare Project Yellow Button, published by xShare Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 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

Yellow Button Technical view

The technology domain describes the technology stack and the infrastructure required to support the xShare Yellow Button.

This includes:

Overview

Technical standards, specifications, and security considerations are documented in this version of the guide by starting from a sequence diagram (diagram below) representing how the application view sequence is implemented.

The diagram highlights (in yellow) the roles (i.e. the participants) that Yellow Button implementers can claim conformance to:

More details about these roles (actors in the IHE world) are documented in the xShare Yellow Button Participants page.

Messages supported by these roles (transactions in the IHE world) are reported in the xShare Yellow Button Messages section.

By clicking on the message in the diagrams readers can directly access the details of that message, including conformance rules.

The messages for which technical validation is supposed to be performed are higlighted in blue.

xShare Yellow Button realization

Natural PersonNatural PersonxShare Yellow Button ProviderxShare Yellow Button ProviderxShare Yellow Button ConsumerxShare Yellow Button ConsumerNatural person's StorageNatural person's StorageNatural person authentication (pre-condition)"Natural person IAA"Natural person authenticationSearch and Select Health DataSearch and Select personal health dataSearch and SelectRetrieve and Format Health DataRetrieve and Format Natural personal health dataRetrieve and FormatSelects OptionsoptSelect optionsSelect OptionsYellow Button OptionsoptDownloaddownload[download]optOne-time Sharegenerate link[generate SHL URI]show linkshare link[process SHL URI][request SHL Manifest]health dataoptLinked Options (Not implemented in this version)generate link[SHL generated](flag L: long-term)show linkshare link[get data from SHL]Updates Natural person's Health DataHealth Data

xShare Yellow Button Participants

Yellow Button implementers can claim conformance to the yellow button by implementing one of both of these participants:

  • The xShare Yellow Button Provider
  • The xShare Yellow Button Consumer

The xShare Yellow Button Provider shall be able to act as:

  • xShare Yellow Button Content Creator, always
  • xShare Yellow Button Link Provider, if the One-time Share option is supported

The xShare Yellow Button Consumer shall be able to act as:

  • xShare Yellow Button Content Consumer, always
  • xShare Yellow Button Link Consumer, if the One-time Share option is supported

More details about these roles is provided in the xShare Yellow Button participants page.

xShare Yellow Button ConsumerxShare Yellow Button ProviderxShare Yellow Button Content CreatorxShare Yellow Button Link ProviderxShare Yellow Button Content ConsumerxShare Yellow Button Link ConsumerContent Consumer RequiredContent Creator RequiredYellow Button

xShare Yellow Button Messages

This section describes the messages used by the sequence diagrams above.

Natural person authentication

For this version of the guide the natural person identification, authentication and authorization is a Yellow Button pre-requisite.

See Yellow Button Business View and Yellow Button Applicaiton View.

Conformance

There are not technical specifications to claim conformance with.

Yellow button adopters have however to:

  • Demonstrate that only authenticated Natural Persons can access the xShare Yellow Button features.
  • Claim that user autentication is realized in conformance with the European Regulations.

Search and Select

For this version of the guide the search and selection of personal health data is an internal activity.

Conformance

There are not technical specifications to claim conformance with.

Yellow button adopters have however to:

  • Demonstrate that (only) authenticated Natural Persons can search for and select the documents or data they wish to download or share.

Retrieve and Format

For this version of the guide the Retrieve and Format Natural personal health data is an internal activity.

Conformance

There are not technical specifications to claim conformance with.

Select Options

For this version of the guide the Select Options is an internal activity.

Conformance

There are not technical specifications to claim conformance with.

Download

This version of the guide does not specify how downloaded data are stored into the Natural person's storage.

Conformance

Generate SHL URI

The xShare Yellow Button Provider generates a SMART Health Link URI.

Conformance

Process SHL URI

The xShare Yellow Button Provider process a SMART Health Link URI.

Conformance

Request SHL Manifest

The xShare Yellow Button Link Consumer retrieves a SMART Health Links's manifest from the xShare Yellow Button Link Provider

Conformance
xShare Yellow Button Provider

  • Yellow button adopters implementing Request SHL Manifest as Consumer shall act as xShare Yellow Button Link Consumer

  • The SMART Health Links's manifest is retrieved in conformance with SMART Health Link Manifest Request

  • The SMART Health Links's manifest shall conform with at least one of the content specifications listed in the Yellow Button Information view page.

xShare Yellow Button Consumer

  • Yellow button adopters implementing Request SHL Manifest as Creator shall act as xShare Yellow Button Link Provider

  • The SMART Health Links's manifest is provided in conformance with SMART Health Link Manifest Request

  • The SMART Health Links's manifest shall conform with at least one of the content specifications listed in the Yellow Button Information view page.