OpenAthens federation metadata extensions

Like most federations, we have some extensions in the metadata. These do not affect the transfer of users to resources, but can be used for reference - for example if you wanted to display an organisation name for a logged-in user, you would reference the metadata for the name represented by their scope rather than trusting that what's in your records won't ever change.

The extensions in the OpenAthens federation are:

<shibmd:Scope> - A list of scopes associated with an entity. Can be a regular expression if stated. Always at least one.
<oaf:ScopedUIInfo> - Defines the <mdui:DisplayName> to associate with a given scope.
<mdui:UIInfo>
- <mdui:DisplayName> - The display name of the entity
- <mdui:Description> - A description of the entity, generally the same as the display name
- <mdui:Logo> - Organisation logos as base64 encoded PNG images (where present)
<mdui:DiscoHints> - Discovery helpers such as email domains and Geolocation
- <mdui:DomainHint> - Email domains (where present)
- <mdui:GeolocationHint> - Latitude, Longitude pairs (where present)

Example XML

XML

<md:Extensions>
    <shibmd:Scope regexp="false">4315904.eng.nhs.uk</shibmd:Scope>
    <shibmd:Scope regexp="false">4112875.eng.nhs.uk</shibmd:Scope>
    <shibmd:Scope regexp="false">4223726.eng.nhs.uk</shibmd:Scope>
    <shibmd:Scope regexp="false">5762753.eng.nhs.uk</shibmd:Scope>
    <shibmd:Scope regexp="false">4315924.eng.nhs.uk</shibmd:Scope>
    <oaf:ScopedUIInfo scope="4315904.eng.nhs.uk">
        <mdui:DisplayName xml:lang="en">University Hospitals of Leicester NHS Trust (LRI, LGH and Glenfield )</mdui:DisplayName>
    </oaf:ScopedUIInfo>
    <oaf:ScopedUIInfo scope="4112875.eng.nhs.uk">
        <mdui:DisplayName xml:lang="en">Bridgewater Community Healthcare NHS Trust</mdui:DisplayName>
    </oaf:ScopedUIInfo>
    <oaf:ScopedUIInfo scope="4223726.eng.nhs.uk">
        <mdui:DisplayName xml:lang="en">Croydon Health Services NHS Trust</mdui:DisplayName>
    </oaf:ScopedUIInfo>
    <oaf:ScopedUIInfo scope="5762753.eng.nhs.uk">
        <mdui:DisplayName xml:lang="en">Hospices in Cornwall</mdui:DisplayName>
    </oaf:ScopedUIInfo>
    <oaf:ScopedUIInfo scope="4315924.eng.nhs.uk">
        <mdui:DisplayName xml:lang="en">School of Health & Related Research (Scharr), University of Sheffield</mdui:DisplayName>
    </oaf:ScopedUIInfo>
    <mdui:UIInfo>
        <mdui:DisplayName xml:lang="en">NHS in England</mdui:DisplayName>
        <mdui:Description xml:lang="en">NHS in England</mdui:Description>
        <mdui:Logo height="256" width="256">
            data:image/png;base64,Actual_String_Removed_for_Brevity
        </mdui:Logo>
        <mdui:Logo height="75" width="75">
            data:image/png;base64,Actual_String_Removed_for_Brevity
        </mdui:Logo>
    </mdui:UIInfo>
    <mdui:DiscoHints>
        <mdui:DomainHint>leedsth.nhs.uk</mdui:DomainHint>
        <mdui:DomainHint>poole.nhs.uk</mdui:DomainHint>
        <mdui:GeolocationHint>geo:53.820679,-3.016269</mdui:GeolocationHint>
        <mdui:GeolocationHint>geo:52.400579,-1.5078341</mdui:GeolocationHint>
    </mdui:DiscoHints>
</md:Extensions>

If you're using these to build your own WAYF that covers consortia organisations such as NHS England, where there are many scoped organisation units under the same entity then you would want to use name elements in the following order:

Use ScopedUIInfo if present
Otherwise use UIInfo if present
Otherwise use OrganizationDisplayName (standard metadata, not an extension)

Within the same entity it is safe to de-duplicate names as the entityID is the same but we cannot guarantee that duplicate or similar names will not appear under different entities so you will need to code for that.