http://hl7.org/fhir/CodeSystem/iana-link-relations|5.0.0
name
LinkRelationTypes
LinkRelationTypes
package
hl7.fhir.r5.core@5.0.0
hl7.fhir.r5.core@5.0.0
content
complete
complete
status
active
active
Link Relation Types
Link Relation Types defined at https://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
| code | display | definition | hierarchy |
|---|---|---|---|
| about | Refers to a resource that is the subject of the link's context. | Refers to a resource that is the subject of the link's context.... | |
| acl | Asserts that the link target provides an access control description for the link context. | Asserts that the link target provides an access control description for the link context.... | |
| alternate | Refers to a substitute for this context | Refers to a substitute for this context... | |
| amphtml | Used to reference alternative content that uses the AMP profile of the HTML format. | Used to reference alternative content that uses the AMP profile of the HTML format.... | |
| appendix | Refers to an appendix. | Refers to an appendix.... | |
| apple-touch-icon | Refers to an icon for the context. Synonym for icon. | Refers to an icon for the context. Synonym for icon.... | |
| apple-touch-startup-image | Refers to a launch screen for the context. | Refers to a launch screen for the context.... | |
| archives | Refers to a collection of records, documents, or other\n materials of historical interest. | Refers to a collection of records, documents, or other\n materials of historical interest.... | |
| author | Refers to the context's author. | Refers to the context's author.... | |
| blocked-by | Identifies the entity that blocks access to a resource\n following receipt of a legal demand. | Identifies the entity that blocks access to a resource\n following receipt of a legal demand.... | |
| bookmark | Gives a permanent link to use for bookmarking purposes. | Gives a permanent link to use for bookmarking purposes.... | |
| canonical | Designates the preferred version of a resource (the IRI and its contents). | Designates the preferred version of a resource (the IRI and its contents).... | |
| chapter | Refers to a chapter in a collection of resources. | Refers to a chapter in a collection of resources.... | |
| cite-as | Indicates that the link target is preferred over the link context for the purpose of permanent citation. | Indicates that the link target is preferred over the link context for the purpose of permanent citat... | |
| collection | The target IRI points to a resource which represents the collection resource for the context IRI. | The target IRI points to a resource which represents the collection resource for the context IRI.... | |
| contents | Refers to a table of contents. | Refers to a table of contents.... | |
| convertedFrom | The document linked to was later converted to the\n document that contains this link relation. For example, an RFC can\n have a link to the Internet-Draft that became the RFC; in that case,\n the link relation would be \"convertedFrom\". | The document linked to was later converted to the\n document that contains this link relation. ... | |
| copyright | Refers to a copyright statement that applies to the\n link's context. | Refers to a copyright statement that applies to the\n link's context.... | |
| create-form | The target IRI points to a resource where a submission form can be obtained. | The target IRI points to a resource where a submission form can be obtained.... | |
| current | Refers to a resource containing the most recent\n item(s) in a collection of resources. | Refers to a resource containing the most recent\n item(s) in a collection of resources.... | |
| describedby | Refers to a resource providing information about the\n link's context. | Refers to a resource providing information about the\n link's context.... | |
| describes | The relationship A 'describes' B asserts that\n resource A provides a description of resource B. There are no\n constraints on the format or representation of either A or B,\n neither are there any further constraints on either resource. | The relationship A 'describes' B asserts that\n resource A provides a description of resource B... | |
| disclosure | Refers to a list of patent disclosures made with respect to \n material for which 'disclosure' relation is specified. | Refers to a list of patent disclosures made with respect to \n material for which 'disclosure' ... | |
| dns-prefetch | Used to indicate an origin that will be used to fetch required \n resources for the link context, and that the user agent ought to resolve \n as early as possible. | Used to indicate an origin that will be used to fetch required \n resources for the link contex... | |
| duplicate | Refers to a resource whose available representations\n are byte-for-byte identical with the corresponding representations of\n the context IRI. | Refers to a resource whose available representations\n are byte-for-byte identical with the cor... | |
| edit | Refers to a resource that can be used to edit the\n link's context. | Refers to a resource that can be used to edit the\n link's context.... | |
| edit-form | The target IRI points to a resource where a submission form for\n editing associated resource can be obtained. | The target IRI points to a resource where a submission form for\n editing associated resource c... | |
| edit-media | Refers to a resource that can be used to edit media\n associated with the link's context. | Refers to a resource that can be used to edit media\n associated with the link's context.... | |
| enclosure | Identifies a related resource that is potentially\n large and might require special handling. | Identifies a related resource that is potentially\n large and might require special handling.... | |
| external | Refers to a resource that is not part of the same site as the current context. | Refers to a resource that is not part of the same site as the current context.... | |
| first | An IRI that refers to the furthest preceding resource\n in a series of resources. | An IRI that refers to the furthest preceding resource\n in a series of resources.... | |
| glossary | Refers to a glossary of terms. | Refers to a glossary of terms.... | |
| help | Refers to context-sensitive help. | Refers to context-sensitive help.... | |
| hosts | Refers to a resource hosted by the server indicated by\n the link context. | Refers to a resource hosted by the server indicated by\n the link context.... | |
| hub | Refers to a hub that enables registration for\n notification of updates to the context. | Refers to a hub that enables registration for\n notification of updates to the context.... | |
| icon | Refers to an icon representing the link's context. | Refers to an icon representing the link's context.... | |
| index | Refers to an index. | Refers to an index.... | |
| intervalAfter | refers to a resource associated with a time interval that ends before the beginning of the time interval associated with the context resource | refers to a resource associated with a time interval that ends before the beginning of the time inte... | |
| intervalBefore | refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource | refers to a resource associated with a time interval that begins after the end of the time interval ... | |
| intervalContains | refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource | refers to a resource associated with a time interval that begins after the beginning of the time int... | |
| intervalDisjoint | refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource, or ends before the beginning of the time interval associated with the context resource | refers to a resource associated with a time interval that begins after the end of the time interval ... | |
| intervalDuring | refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource | refers to a resource associated with a time interval that begins before the beginning of the time in... | |
| intervalEquals | refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource | refers to a resource associated with a time interval whose beginning coincides with the beginning of... | |
| intervalFinishedBy | refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource | refers to a resource associated with a time interval that begins after the beginning of the time int... | |
| intervalFinishes | refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource | refers to a resource associated with a time interval that begins before the beginning of the time in... | |
| intervalIn | refers to a resource associated with a time interval that begins before or is coincident with the beginning of the time interval associated with the context resource, and ends after or is coincident with the end of the time interval associated with the context resource | refers to a resource associated with a time interval that begins before or is coincident with the be... | |
| intervalMeets | refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resource | refers to a resource associated with a time interval whose beginning coincides with the end of the t... | |
| intervalMetBy | refers to a resource associated with a time interval whose end coincides with the beginning of the time interval associated with the context resource | refers to a resource associated with a time interval whose end coincides with the beginning of the t... | |
| intervalOverlappedBy | refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the beginning of the time interval associated with the context resource | refers to a resource associated with a time interval that begins before the beginning of the time in... | |
| intervalOverlaps | refers to a resource associated with a time interval that begins before the end of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource | refers to a resource associated with a time interval that begins before the end of the time interval... | |
| intervalStartedBy | refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource | refers to a resource associated with a time interval whose beginning coincides with the beginning of... | |
| intervalStarts | refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource | refers to a resource associated with a time interval whose beginning coincides with the beginning of... | |
| item | The target IRI points to a resource that is a member of the collection represented by the context IRI. | The target IRI points to a resource that is a member of the collection represented by the context IR... | |
| last | An IRI that refers to the furthest following resource\n in a series of resources. | An IRI that refers to the furthest following resource\n in a series of resources.... | |
| latest-version | Points to a resource containing the latest (e.g.,\n current) version of the context. | Points to a resource containing the latest (e.g.,\n current) version of the context.... | |
| license | Refers to a license associated with this context. | Refers to a license associated with this context.... | |
| linkset | The link target of a link with the \"linkset\" relation\n type provides a set of links, including links in which the link\n context of the link participates.\n | The link target of a link with the \"linkset\" relation\n type provides a set of links, includi... | |
| lrdd | Refers to further information about the link's context,\n expressed as a LRDD (\"Link-based Resource Descriptor Document\")\n resource. See for information about\n processing this relation type in host-meta documents. When used\n elsewhere, it refers to additional links and other metadata.\n Multiple instances indicate additional LRDD resources. LRDD\n resources MUST have an \"application/xrd+xml\" representation, and\n MAY have others. | Refers to further information about the link's context,\n expressed as a LRDD (\"Link-based Res... | |
| manifest | Links to a manifest file for the context. | Links to a manifest file for the context.... | |
| mask-icon | Refers to a mask that can be applied to the icon for the context. | Refers to a mask that can be applied to the icon for the context.... | |
| media-feed | Refers to a feed of personalised media recommendations relevant to the link context. | Refers to a feed of personalised media recommendations relevant to the link context.... | |
| memento | The Target IRI points to a Memento, a fixed resource that will not change state anymore. | The Target IRI points to a Memento, a fixed resource that will not change state anymore.... | |
| micropub | Links to the context's Micropub endpoint. | Links to the context's Micropub endpoint.... | |
| modulepreload | Refers to a module that the user agent is to preemptively fetch and store for use in the current context. | Refers to a module that the user agent is to preemptively fetch and store for use in the current con... | |
| monitor | Refers to a resource that can be used to monitor changes in an HTTP resource.\n | Refers to a resource that can be used to monitor changes in an HTTP resource.\n ... | |
| monitor-group | Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.\n | Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.\n ... | |
| next | Indicates that the link's context is a part of a series, and\n that the next in the series is the link target.\n | Indicates that the link's context is a part of a series, and\n that the next in the series is t... | |
| next-archive | Refers to the immediately following archive resource. | Refers to the immediately following archive resource.... | |
| nofollow | Indicates that the context’s original author or publisher does not endorse the link target. | Indicates that the context’s original author or publisher does not endorse the link target.... | |
| noopener | Indicates that any newly created top-level browsing context which results from following the link will not be an auxiliary browsing context. | Indicates that any newly created top-level browsing context which results from following the link wi... | |
| noreferrer | Indicates that no referrer information is to be leaked when following the link. | Indicates that no referrer information is to be leaked when following the link.... | |
| opener | Indicates that any newly created top-level browsing context which results from following the link will be an auxiliary browsing context. | Indicates that any newly created top-level browsing context which results from following the link wi... | |
| openid2.local_id | Refers to an OpenID Authentication server on which the context relies for an assertion that the end user controls an Identifier. | Refers to an OpenID Authentication server on which the context relies for an assertion that the end ... | |
| openid2.provider | Refers to a resource which accepts OpenID Authentication protocol messages for the context. | Refers to a resource which accepts OpenID Authentication protocol messages for the context.... | |
| original | The Target IRI points to an Original Resource. | The Target IRI points to an Original Resource.... | |
| P3Pv1 | Refers to a P3P privacy policy for the context. | Refers to a P3P privacy policy for the context.... | |
| payment | Indicates a resource where payment is accepted. | Indicates a resource where payment is accepted.... | |
| pingback | Gives the address of the pingback resource for the link context. | Gives the address of the pingback resource for the link context.... | |
| preconnect | Used to indicate an origin that will be used to fetch required \n resources for the link context. Initiating an early connection, which \n includes the DNS lookup, TCP handshake, and optional TLS negotiation, \n allows the user agent to mask the high latency costs of establishing a \n connection. | Used to indicate an origin that will be used to fetch required \n resources for the link contex... | |
| predecessor-version | Points to a resource containing the predecessor\n version in the version history.\n | Points to a resource containing the predecessor\n version in the version history.\n ... | |
| prefetch | The prefetch link relation type is used to identify a resource \n that might be required by the next navigation from the link context, and \n that the user agent ought to fetch, such that the user agent can deliver a \n faster response once the resource is requested in the future. | The prefetch link relation type is used to identify a resource \n that might be required by the... | |
| preload | Refers to a resource that should be loaded early in the \n processing of the link's context, without blocking rendering. | Refers to a resource that should be loaded early in the \n processing of the link's context, wi... | |
| prerender | Used to identify a resource that might be required by the next \n navigation from the link context, and that the user agent ought to fetch \n and execute, such that the user agent can deliver a faster response once \n the resource is requested in the future. | Used to identify a resource that might be required by the next \n navigation from the link cont... | |
| prev | Indicates that the link's context is a part of a series, and\n that the previous in the series is the link target.\n | Indicates that the link's context is a part of a series, and\n that the previous in the series ... | |
| preview | Refers to a resource that provides a preview of the link's context. | Refers to a resource that provides a preview of the link's context.... | |
| previous | Refers to the previous resource in an ordered series\n of resources. Synonym for \"prev\". | Refers to the previous resource in an ordered series\n of resources. Synonym for \"prev\".... | |
| prev-archive | Refers to the immediately preceding archive resource. | Refers to the immediately preceding archive resource.... | |
| privacy-policy | Refers to a privacy policy associated with the link's context. | Refers to a privacy policy associated with the link's context.... | |
| profile | Identifying that a resource representation conforms\nto a certain profile, without affecting the non-profile semantics\nof the resource representation. | Identifying that a resource representation conforms\nto a certain profile, without affecting the non... | |
| publication | Links to a publication manifest. A manifest represents \n structured information about a publication, such as informative metadata, \n a list of resources, and a default reading order. | Links to a publication manifest. A manifest represents \n structured information about a public... | |
| related | Identifies a related resource. | Identifies a related resource.... | |
| restconf | Identifies the root of RESTCONF API as configured on this HTTP server.\n The \"restconf\" relation defines the root of the API defined in RFC8040.\n Subsequent revisions of RESTCONF will use alternate relation values to support \n protocol versioning. | Identifies the root of RESTCONF API as configured on this HTTP server.\n The \"restconf\" relat... | |
| replies | Identifies a resource that is a reply to the context\n of the link.\n | Identifies a resource that is a reply to the context\n of the link.\n ... | |
| ruleinput | The resource identified by the link target provides an input value to an \n instance of a rule, where the resource which represents the rule instance is \n identified by the link context.\n | The resource identified by the link target provides an input value to an \n instance of a rule, w... | |
| search | Refers to a resource that can be used to search through\n the link's context and related resources. | Refers to a resource that can be used to search through\n the link's context and related resour... | |
| section | Refers to a section in a collection of resources. | Refers to a section in a collection of resources.... | |
| self | Conveys an identifier for the link's context.\n | Conveys an identifier for the link's context.\n ... | |
| service | Indicates a URI that can be used to retrieve a\n service document. | Indicates a URI that can be used to retrieve a\n service document.... | |
| service-desc | Identifies service description for the context that\n is primarily intended for consumption by machines. | Identifies service description for the context that\n is primarily intended for consumption by ... | |
| service-doc | Identifies service documentation for the context that\n is primarily intended for human consumption. | Identifies service documentation for the context that\n is primarily intended for human consump... | |
| service-meta | Identifies general metadata for the context that is\n primarily intended for consumption by machines. | Identifies general metadata for the context that is\n primarily intended for consumption by mac... | |
| sponsored | Refers to a resource that is within a context that is \n\t\tsponsored (such as advertising or another compensation agreement). | Refers to a resource that is within a context that is \n\t\tsponsored (such as advertising or anothe... | |
| start | Refers to the first resource in a collection of\n resources. | Refers to the first resource in a collection of\n resources.... | |
| status | Identifies a resource that represents the context's\n status. | Identifies a resource that represents the context's\n status.... | |
| stylesheet | Refers to a stylesheet. | Refers to a stylesheet.... | |
| subsection | Refers to a resource serving as a subsection in a\n collection of resources. | Refers to a resource serving as a subsection in a\n collection of resources.... | |
| successor-version | Points to a resource containing the successor version\n in the version history.\n | Points to a resource containing the successor version\n in the version history.\n ... | |
| sunset | Identifies a resource that provides information about\n the context's retirement policy.\n | Identifies a resource that provides information about\n the context's retirement policy.\n ... | |
| tag | Gives a tag (identified by the given address) that applies to\n the current document.\n | Gives a tag (identified by the given address) that applies to\n the current document.\n ... | |
| terms-of-service | Refers to the terms of service associated with the link's context. | Refers to the terms of service associated with the link's context.... | |
| timegate | The Target IRI points to a TimeGate for an Original Resource. | The Target IRI points to a TimeGate for an Original Resource.... | |
| timemap | The Target IRI points to a TimeMap for an Original Resource. | The Target IRI points to a TimeMap for an Original Resource.... | |
| type | Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance. | Refers to a resource identifying the abstract semantic type of which the link's context is considere... | |
| ugc | Refers to a resource that is within a context that is User Generated Content.\n | Refers to a resource that is within a context that is User Generated Content.\n ... | |
| up | Refers to a parent document in a hierarchy of\n documents.\n | Refers to a parent document in a hierarchy of\n documents.\n ... | |
| version-history | Points to a resource containing the version history\n for the context.\n | Points to a resource containing the version history\n for the context.\n ... | |
| via | Identifies a resource that is the source of the\n information in the link's context.\n | Identifies a resource that is the source of the\n information in the link's context.\n ... | |
| webmention | Identifies a target URI that supports the Webmention protocol.\n This allows clients that mention a resource in some form of publishing process\n to contact that endpoint and inform it that this resource has been mentioned. | Identifies a target URI that supports the Webmention protocol.\n This allows clients that mention... | |
| working-copy | Points to a working copy for this resource. | Points to a working copy for this resource.... | |
| working-copy-of | Points to the versioned resource from which this\n working copy was obtained.\n | Points to the versioned resource from which this\n working copy was obtained.\n ... |