Package org.hl7.fhir.r5.model
Enum Bundle.LinkRelationTypes
- All Implemented Interfaces:
Serializable
,Comparable<Bundle.LinkRelationTypes>
- Enclosing class:
Bundle
-
Enum Constant Summary
Enum ConstantDescriptionRefers to a resource that is the subject of the link's context.Asserts that the link target provides an access control description for the link context.Refers to a substitute for this contextUsed to reference alternative content that uses the AMP profile of the HTML format.Refers to an appendix.Refers to an icon for the context.Refers to a launch screen for the context.Refers to a collection of records, documents, or other\n materials of historical interest.Refers to the context's author.Identifies the entity that blocks access to a resource\n following receipt of a legal demand.Gives a permanent link to use for bookmarking purposes.Designates the preferred version of a resource (the IRI and its contents).Refers to a chapter in a collection of resources.Indicates that the link target is preferred over the link context for the purpose of permanent citation.The target IRI points to a resource which represents the collection resource for the context IRI.Refers to a table of contents.The document linked to was later converted to the\n document that contains this link relation.Refers to a copyright statement that applies to the\n link's context.The target IRI points to a resource where a submission form can be obtained.Refers to a resource containing the most recent\n item(s) in a collection of resources.Refers to a resource providing information about the\n link's context.The relationship A 'describes' B asserts that\n resource A provides a description of resource B.Refers to a list of patent disclosures made with respect to \n material for which 'disclosure' relation is specified.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.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 that can be used to edit the\n link's context.The target IRI points to a resource where a submission form for\n editing associated resource can be obtained.Refers to a resource that can be used to edit media\n associated with the link's context.Identifies a related resource that is potentially\n large and might require special handling.Refers to a resource that is not part of the same site as the current context.An IRI that refers to the furthest preceding resource\n in a series of resources.Refers to a glossary of terms.Refers to context-sensitive help.Refers to a resource hosted by the server indicated by\n the link context.Refers to a hub that enables registration for\n notification of updates to the context.Refers to an icon representing the link's context.Refers to an index.refers to a resource associated with a time interval that ends before the beginning of the time interval associated with the context resourcerefers to a resource associated with a time interval that begins after the end of the time interval associated with the context resourcerefers 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 resourcerefers 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 resourcerefers 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 resourcerefers 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 resourcerefers 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 resourcerefers 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 resourcerefers 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 resourcerefers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resourcerefers to a resource associated with a time interval whose end coincides with the beginning of the time interval associated with the context resourcerefers 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 resourcerefers 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 resourcerefers 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 resourcerefers 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 resourceThe target IRI points to a resource that is a member of the collection represented by the context IRI.An IRI that refers to the furthest following resource\n in a series of resources.Points to a resource containing the latest (e.g.,\n current) version of the context.Refers to a license associated with this context.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.\nRefers to further information about the link's context,\n expressed as a LRDD (\"Link-based Resource Descriptor Document\")\n resource.Links to a manifest file for the context.Refers to a mask that can be applied to the icon for the context.Refers to a feed of personalised media recommendations relevant to the link context.The Target IRI points to a Memento, a fixed resource that will not change state anymore.Links to the context's Micropub endpoint.Refers to a module that the user agent is to preemptively fetch and store for use in the current context.Refers to a resource that can be used to monitor changes in an HTTP resource.\nRefers to a resource that can be used to monitor changes in a specified group of HTTP resources.\nIndicates that the link's context is a part of a series, and\n that the next in the series is the link target.\nRefers to the immediately following archive resource.Indicates that the context?s original author or publisher does not endorse the link target.Indicates that any newly created top-level browsing context which results from following the link will not be an auxiliary browsing context.Indicates that no referrer information is to be leaked when following the link.added to help the parsers with the generic typesIndicates that any newly created top-level browsing context which results from following the link will be an auxiliary browsing context.Refers to an OpenID Authentication server on which the context relies for an assertion that the end user controls an Identifier.Refers to a resource which accepts OpenID Authentication protocol messages for the context.The Target IRI points to an Original Resource.Refers to a P3P privacy policy for the context.Indicates a resource where payment is accepted.Gives the address of the pingback resource for the link context.Used to indicate an origin that will be used to fetch required \n resources for the link context.Points to a resource containing the predecessor\n version in the version history.\nThe 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.Refers to a resource that should be loaded early in the \n processing of the link's context, without blocking rendering.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.Indicates that the link's context is a part of a series, and\n that the previous in the series is the link target.\nRefers to the immediately preceding archive resource.Refers to a resource that provides a preview of the link's context.Refers to the previous resource in an ordered series\n of resources.Refers to a privacy policy associated with the link's context.Identifying that a resource representation conforms\nto a certain profile, without affecting the non-profile semantics\nof the resource representation.Links to a publication manifest.Identifies a related resource.Identifies a resource that is a reply to the context\n of the link.\nIdentifies 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.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.\nRefers to a resource that can be used to search through\n the link's context and related resources.Refers to a section in a collection of resources.Conveys an identifier for the link's context.\nIndicates a URI that can be used to retrieve a\n service document.Identifies service description for the context that\n is primarily intended for consumption by machines.Identifies service documentation for the context that\n is primarily intended for human consumption.Identifies general metadata for the context that is\n primarily intended for consumption by machines.Refers to a resource that is within a context that is \n sponsored (such as advertising or another compensation agreement).Refers to the first resource in a collection of\n resources.Identifies a resource that represents the context's\n status.Refers to a stylesheet.Refers to a resource serving as a subsection in a\n collection of resources.Points to a resource containing the successor version\n in the version history.\nIdentifies a resource that provides information about\n the context's retirement policy.\nGives a tag (identified by the given address) that applies to\n the current document.\nRefers to the terms of service associated with the link's context.The Target IRI points to a TimeGate for an Original Resource.The Target IRI points to a TimeMap for an Original Resource.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 that is within a context that is User Generated Content.\nRefers to a parent document in a hierarchy of\n documents.\nPoints to a resource containing the version history\n for the context.\nIdentifies a resource that is the source of the\n information in the link's context.\nIdentifies 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.Points to a working copy for this resource.Points to the versioned resource from which this\n working copy was obtained.\n -
Method Summary
Modifier and TypeMethodDescriptionstatic Bundle.LinkRelationTypes
toCode()
static Bundle.LinkRelationTypes
Returns the enum constant of this type with the specified name.static Bundle.LinkRelationTypes[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ABOUT
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. -
ALTERNATE
Refers to a substitute for this context -
AMPHTML
Used to reference alternative content that uses the AMP profile of the HTML format. -
APPENDIX
Refers to an appendix. -
APPLETOUCHICON
Refers to an icon for the context. Synonym for icon. -
APPLETOUCHSTARTUPIMAGE
Refers to a launch screen for the context. -
ARCHIVES
Refers to a collection of records, documents, or other\n materials of historical interest. -
AUTHOR
Refers to the context's author. -
BLOCKEDBY
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. -
CANONICAL
Designates the preferred version of a resource (the IRI and its contents). -
CHAPTER
Refers to a chapter in a collection of resources. -
CITEAS
Indicates that the link target is preferred over the link context for the purpose of permanent citation. -
COLLECTION
The target IRI points to a resource which represents the collection resource for the context IRI. -
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\". -
COPYRIGHT
Refers to a copyright statement that applies to the\n link's context. -
CREATEFORM
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. -
DESCRIBEDBY
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. -
DISCLOSURE
Refers to a list of patent disclosures made with respect to \n material for which 'disclosure' relation is specified. -
DNSPREFETCH
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. -
DUPLICATE
Refers to a resource whose available representations\n are byte-for-byte identical with the corresponding representations of\n the context IRI. -
EDIT
Refers to a resource that can be used to edit the\n link's context. -
EDITFORM
The target IRI points to a resource where a submission form for\n editing associated resource can be obtained. -
EDITMEDIA
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. -
EXTERNAL
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. -
GLOSSARY
Refers to a glossary of terms. -
HELP
Refers to context-sensitive help. -
HOSTS
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. -
ICON
Refers to an icon representing the link's context. -
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 -
INTERVALBEFORE
refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
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 -
ITEM
The target IRI points to a resource that is a member of the collection represented by the context IRI. -
LAST
An IRI that refers to the furthest following resource\n in a series of resources. -
LATESTVERSION
Points to a resource containing the latest (e.g.,\n current) version of the context. -
LICENSE
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 -
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. -
MANIFEST
Links to a manifest file for the context. -
MASKICON
Refers to a mask that can be applied to the icon for the context. -
MEDIAFEED
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. -
MICROPUB
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. -
MONITOR
Refers to a resource that can be used to monitor changes in an HTTP resource.\n -
MONITORGROUP
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 -
NEXTARCHIVE
Refers to the immediately following archive resource. -
NOFOLLOW
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. -
NOREFERRER
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. -
OPENID2_LOCALID
Refers to an OpenID Authentication server on which the context relies for an assertion that the end user controls an Identifier. -
OPENID2_PROVIDER
Refers to a resource which accepts OpenID Authentication protocol messages for the context. -
ORIGINAL
The Target IRI points to an Original Resource. -
P3PV1
Refers to a P3P privacy policy for the context. -
PAYMENT
Indicates a resource where payment is accepted. -
PINGBACK
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. -
PREDECESSORVERSION
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. -
PRELOAD
Refers to a resource that should be loaded early in the \n processing of the link's context, without blocking rendering. -
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. -
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 -
PREVIEW
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\". -
PREVARCHIVE
Refers to the immediately preceding archive resource. -
PRIVACYPOLICY
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. -
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. -
RELATED
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. -
REPLIES
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 -
SEARCH
Refers to a resource that can be used to search through\n the link's context and related resources. -
SECTION
Refers to a section in a collection of resources. -
SELF
Conveys an identifier for the link's context.\n -
SERVICE
Indicates a URI that can be used to retrieve a\n service document. -
SERVICEDESC
Identifies service description for the context that\n is primarily intended for consumption by machines. -
SERVICEDOC
Identifies service documentation for the context that\n is primarily intended for human consumption. -
SERVICEMETA
Identifies general metadata for the context that is\n primarily intended for consumption by machines. -
SPONSORED
Refers to a resource that is within a context that is \n sponsored (such as advertising or another compensation agreement). -
START
Refers to the first resource in a collection of\n resources. -
STATUS
Identifies a resource that represents the context's\n status. -
STYLESHEET
Refers to a stylesheet. -
SUBSECTION
Refers to a resource serving as a subsection in a\n collection of resources. -
SUCCESSORVERSION
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 -
TAG
Gives a tag (identified by the given address) that applies to\n the current document.\n -
TERMSOFSERVICE
Refers to the terms of service associated with the link's context. -
TIMEGATE
The Target IRI points to a TimeGate for an Original Resource. -
TIMEMAP
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. -
UGC
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 -
VERSIONHISTORY
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 -
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. -
WORKINGCOPY
Points to a working copy for this resource. -
WORKINGCOPYOF
Points to the versioned resource from which this\n working copy was obtained.\n -
NULL
added to help the parsers with the generic types
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
fromCode
public static Bundle.LinkRelationTypes fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException - Throws:
org.hl7.fhir.exceptions.FHIRException
-
toCode
-
getSystem
-
getDefinition
-
getDisplay
-