NICE Syndication Services Link Relationships

Link Relationships

What are they?

A link is a connection between one web resource and another. The rel or 'relationship' attribute of the link describes the relationship between the current resource and the one being linked to. For example, where a resource is presented in multiple pages, the current page may include link elements that give the addresses of the next and previous pages in the sequence.

The most common relationship that you will see in the set of resources that make up the NICE Syndication Services API is self. As you would expect, this simply gives the address of the current resource.

            <link rel="self" href="http://www.domain.com/paged-resource?page=2"/>
            <link rel="next" href="http://www.domain.com/paged-resource?page=3"/>
            <link rel="prev" href="http://www.domain.com/paged-resource?page=1"/>
          

self

The cannonical address of the current resource

alternate

An alternate representation of the current resource. For example, this could be a link to a page the Evidence Search or other third-party website, or a PDF version of the resource.

up

The resource 'above' the current resource in the hierarchy, i.e. the current resource's parent.

first

The first page of resources in the current set.

previous

The previous page of resources in the current set.

next

The next page of resources in the current set.

last

The last page of resources in the current set.

/linkrels/bnf

The root level reource for the British National Formulary or the British National Formulary for Children

/linkrels/bnf/index

An listing of all sections within the formulary

/linkrels/bnf/sections

A section of the BNF

/linkrels/bnf/full-chapter

A top-level chapter of the BNF including all the sections beneath it.

/linkrels/bnf/section/image

An image that relates to a BNF section.

/linkrels/classification

A service that allows you to classify web-pages or arbitratry fragments of HTML against the Evidence Search ontology.

/linkrels/guidance

A guidance document.

/linkrels/guidance/by-date

All guidance documents published or updated between a given date-range.

/linkrels/guidance/by-date/helper

An HTML form that can create the URI for a guidance-by-date request.

/linkrels/guidance/chapter

A single chapter from a guidance document.

/linkrels/guidance/custom-document

A customised version of a guidance document continuing only selected chapters.

/linkrels/guidance/full-document

A guidance document with all it's chapters included in-line whithin the main content section.

/linkrels/guidance/index

The index of all guidance documents including their metadata.

/linkrels/guidance/programmes

A list of all guidance programmes.

/linkrels/guidance/programme

An individual guidance programme, with links to all the guidance documents that are part of that programme.

/linkrels/guidance/section

A section from a guidance document.

/linkrels/guidance/structured-document

A complete guidance document that contains the component sections of the document in discrete elements, as distince from the FullDocument (above) where all the content is aggragated into a single element.

/linkrels/guidance/structured-documents-by-date

A set of guidance structured documents that were published or updated in a specified date range.

/linkrels/guidance/structured-documents-by-date/helper

An HTML form that can be used to create a URI for guidance structured documents by date requests.

/linkrels/guidance/taxonomy

The Evidence Search taxonomy of guidance documents, with links to the guidance documents from the leaf-level nodes.

/linkrels/medicines

The top-level medicines and prescribing resource.

/linkrels/medicines/chapter

A chapter from a medicines and prescribing document.

/linkrels/medicines/document

A medicines and prescribing document.

/linkrels/medicines/full-document

A medicines and prescribing document with the chapter and section content aggragated into a single element.

/linkrels/medicines/index

An index listing all available medicines and prescribing documents.

/linkrels/medicines/programme

A list of all the documents in a medicines and prescribing programme

/linkrels/medicines/programmes

A list of all medicines and prescribing programmes.

/linkrels/medicines/section

An individual section from a medicines and prescribing document.

/linkrels/pathways

The list of all Evidence Search Pathways

/linkrels/pathways/pathway

An individual pathway.

/linkrels/pathways/path

A path within a pathway.

/linkrels/pathways/full-path

A path within a pathway including all its path nodes and content.

/linkrels/pathways/path/node

A node on a path.

/linkrels/search

A search for Evidence Search resources

/linkrels/search/helper

An HTML form that can be used to create a URI for a search resource.

/linkrels/search/filter

A search that has a filter applied to it.

[examples needed]

/linkrels/services

The list of all the services that you have subscribed to.

/linkrels/topic

An Evidence Search topic

/linkrels/topic/area

A subject area within a topic

/linkrels/topic/item

An item that is included within a topic.