{
"description": "This guide documents the xShare Yellow BUtton for the xShare project.",
"_filename": "ImplementationGuide-hl7.eu.fhir.xshare-yb.json",
"package_name": "hl7.eu.fhir.xshare-yb",
"definition": {
"page": {
"page": [ {
"title": "Home",
"nameUrl": "index.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "index.html"
} ],
"generation": "html"
}, {
"title": "Yellow Button Business view",
"nameUrl": "business.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "business.html"
} ],
"generation": "markdown"
}, {
"title": "Yellow Button Application view",
"nameUrl": "application.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "application.html"
} ],
"generation": "markdown"
}, {
"title": "Yellow Button Information view",
"nameUrl": "content.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "content.html"
} ],
"generation": "markdown"
}, {
"title": "Yellow Button Technical view",
"nameUrl": "technical.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "technical.html"
} ],
"generation": "markdown"
}, {
"title": "Industry Label Certification Process",
"nameUrl": "labeling_process.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "labeling_process.html"
} ],
"generation": "html"
}, {
"title": "Downloads",
"nameUrl": "downloads.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "downloads.html"
} ],
"generation": "markdown"
}, {
"title": "xShare Yellow Button Components",
"nameUrl": "actors.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "actors.html"
} ],
"generation": "markdown"
}, {
"title": "Yellow Button SW Components",
"nameUrl": "yb_components.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "yb_components.html"
} ],
"generation": "markdown"
}, {
"title": "Yellow Button related Tools",
"nameUrl": "yb_tools.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "yb_tools.html"
} ],
"generation": "markdown"
}, {
"title": "About",
"nameUrl": "about.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "about.html"
} ],
"generation": "html"
}, {
"title": "Yellow button usage examples",
"nameUrl": "usage-scenarios.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "usage-scenarios.html"
} ],
"generation": "markdown"
}, {
"title": "Get Started with the xShare Yellow Button Download",
"nameUrl": "get-started-down.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "get-started-down.html"
} ],
"generation": "markdown"
}, {
"title": "Get Started with the xShare Yellow Button One-time Share",
"nameUrl": "get-started-share.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "get-started-share.html"
} ],
"generation": "markdown"
}, {
"title": "Declare and Prove Your Conformance",
"nameUrl": "conformance.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "conformance.html"
} ],
"generation": "markdown"
}, {
"title": "Conformance Statement (example)",
"nameUrl": "conf-statement.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "conf-statement.html"
} ],
"generation": "markdown"
}, {
"title": "Change Log",
"nameUrl": "changes.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "changes.html"
} ],
"generation": "markdown"
} ],
"title": "Table of Contents",
"nameUrl": "toc.html",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "toc.html"
} ],
"generation": "html"
},
"resource": [ {
"name": "xShare Yellow Button Consumer",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
} ],
"reference": {
"reference": "ActorDefinition/actorDefinition-yb-consumer"
},
"description": "An actor that consumes FHIR Document Bundles obtained via download or Smart Health Links, as defined in the xShare Yellow Button Guide.\n\nThe xShare Yellow Button Consumer shall be able to act as:\n- xShare Yellow Button Content Consumer, always\n- xShare Yellow Button Link Consumer, if the One-time Share option is supported\n- xShare Yellow Button Manifest Consumer, if the One-time Share option is supported",
"exampleBoolean": false
}, {
"name": "xShare Yellow Button Consumer Capability Statement",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
} ],
"reference": {
"reference": "CapabilityStatement/capabilityStatement-yb-consumer"
},
"description": "Defines the capabilities of an xShare Yellow Button Consumer, which can retrieve and interpret FHIR Document Bundles obtained via download or Smart Health Links.",
"exampleBoolean": false
}, {
"name": "xShare Yellow Button Provider",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
} ],
"reference": {
"reference": "ActorDefinition/actorDefinition-yb-provider"
},
"description": "An actor that produces HL7 FHIR Document Bundles that can be downloaded or shared using Smart Health Links, as defined in the xShare Yellow Button Guide.\n\nThe xShare Yellow Button Provider shall act:\n- always as xShare Yellow Button Content Creator,\n- if the One-time Share option is supported,\n - as xShare Yellow Button Link Provider,\n - as xShare Yellow Button Manifest Provider.",
"exampleBoolean": false
}, {
"name": "xShare Yellow Button Provider Capability Statement",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
} ],
"reference": {
"reference": "CapabilityStatement/capabilityStatement-yb-provider"
},
"description": "Defines the capabilities of an xShare Yellow Button Provider, responsible for producing FHIR Document Bundles for download or sharing via Smart Health Links.",
"exampleBoolean": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "copyrightyear"
}, {
"url": "value",
"valueString": "2023+"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "releaselabel"
}, {
"url": "value",
"valueString": "trial-use"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "autoload-resources"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-liquid"
}, {
"url": "value",
"valueString": "template/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-liquid"
}, {
"url": "value",
"valueString": "input/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-qa"
}, {
"url": "value",
"valueString": "temp/qa"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-temp"
}, {
"url": "value",
"valueString": "temp/pages"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-output"
}, {
"url": "value",
"valueString": "output"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-suppressed-warnings"
}, {
"url": "value",
"valueString": "input/ignoreWarnings.txt"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-history"
}, {
"url": "value",
"valueString": "http://hl7.eu/fhir/ig/xshare-yb/history.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "template-html"
}, {
"url": "value",
"valueString": "template-page.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "template-md"
}, {
"url": "value",
"valueString": "template-page-md.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-contact"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-context"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-copyright"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-jurisdiction"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-license"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-publisher"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-version"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-wg"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "active-tables"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "fmm-definition"
}, {
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "propagate-status"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "excludelogbinaryformat"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "tabbed-snapshots"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r4#0.8.0"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "copyrightyear"
}, {
"url": "value",
"valueString": "2023+"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "releaselabel"
}, {
"url": "value",
"valueString": "trial-use"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "autoload-resources"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-liquid"
}, {
"url": "value",
"valueString": "template/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-liquid"
}, {
"url": "value",
"valueString": "input/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-qa"
}, {
"url": "value",
"valueString": "temp/qa"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-temp"
}, {
"url": "value",
"valueString": "temp/pages"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-output"
}, {
"url": "value",
"valueString": "output"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-suppressed-warnings"
}, {
"url": "value",
"valueString": "input/ignoreWarnings.txt"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "path-history"
}, {
"url": "value",
"valueString": "http://hl7.eu/fhir/ig/xshare-yb/history.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "template-html"
}, {
"url": "value",
"valueString": "template-page.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "template-md"
}, {
"url": "value",
"valueString": "template-page-md.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-contact"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-context"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-copyright"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-jurisdiction"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-license"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-publisher"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-version"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "apply-wg"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "active-tables"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "fmm-definition"
}, {
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "propagate-status"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "excludelogbinaryformat"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueCode": "tabbed-snapshots"
}, {
"url": "value",
"valueString": "true"
} ]
} ],
"parameter": [ {
"code": "path-resource",
"value": "input/capabilities"
}, {
"code": "path-resource",
"value": "input/examples"
}, {
"code": "path-resource",
"value": "input/extensions"
}, {
"code": "path-resource",
"value": "input/models"
}, {
"code": "path-resource",
"value": "input/operations"
}, {
"code": "path-resource",
"value": "input/profiles"
}, {
"code": "path-resource",
"value": "input/resources"
}, {
"code": "path-resource",
"value": "input/vocabulary"
}, {
"code": "path-resource",
"value": "input/maps"
}, {
"code": "path-resource",
"value": "input/testing"
}, {
"code": "path-resource",
"value": "input/history"
}, {
"code": "path-resource",
"value": "fsh-generated/resources"
}, {
"code": "path-pages",
"value": "template/config"
}, {
"code": "path-pages",
"value": "input/images"
}, {
"code": "path-tx-cache",
"value": "input-cache/txcache"
} ]
},
"date": "2025-11-05T19:20:17+01:00",
"publisher": "xShare Project",
"fhirVersion": [ "4.0.1" ],
"license": "CC0-1.0",
"jurisdiction": [ {
"coding": [ {
"code": "150",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "Europe"
} ]
} ],
"dependsOn": [ {
"id": "hl7tx",
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"version": "6.5.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
} ],
"packageId": "hl7.terminology.r4"
}, {
"id": "hl7ext",
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"version": "5.2.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
} ],
"packageId": "hl7.fhir.uv.extensions.r4"
}, {
"id": "hl7_fhir_uv_ips",
"uri": "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips",
"version": "2.0.0",
"packageId": "hl7.fhir.uv.ips"
}, {
"id": "hl7_fhir_uv_smart_health_cards_and_links",
"uri": "http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links",
"version": "1.0.0",
"packageId": "hl7.fhir.uv.smart-health-cards-and-links"
}, {
"id": "hl7_fhir_eu_laboratory",
"uri": "http://hl7.eu/fhir/laboratory/ImplementationGuide/hl7.fhir.eu.laboratory",
"version": "0.1.1",
"packageId": "hl7.fhir.eu.laboratory"
}, {
"id": "myhealth_eu_fhir_laboratory",
"uri": "http://fhir.ehdsi.eu/laboratory/ImplementationGuide/myhealth.eu.fhir.laboratory",
"version": "0.1.1",
"packageId": "myhealth.eu.fhir.laboratory"
} ],
"name": "XshareYbIg",
"type": null,
"experimental": null,
"resourceType": "ImplementationGuide",
"title": "xShare Project Yellow Button",
"package_version": "0.2.0",
"status": "active",
"id": "8d6d21b9-7ab2-47f7-b651-fe20ed5a933f",
"kind": null,
"url": "http://hl7.eu/fhir/ig/xshare-yb/ImplementationGuide/hl7.eu.fhir.xshare-yb",
"version": "0.2.0",
"packageId": "hl7.eu.fhir.xshare-yb",
"contact": [ {
"name": "xShare Project",
"telecom": [ {
"value": "https://xshare-project.eu/",
"system": "url"
} ]
} ]
}