Package org.hl7.fhir.r5.tools

Class CDSHooksResponse.CDSHooksResponseCardsLinksComponent

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.LogicalBase
org.hl7.fhir.r5.tools.CDSHooksElement
org.hl7.fhir.r5.tools.CDSHooksResponse.CDSHooksResponseCardsLinksComponent
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType
Enclosing class:
CDSHooksResponse
public static class CDSHooksResponse.CDSHooksResponseCardsLinksComponent extends CDSHooksElement
See Also:

  • Field Details

    • label

      protected StringType label
      Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).

    • url

      protected UrlType url
      URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash.

    • type

      protected Enumeration<CDSHooksResponse.CDSLinkTypeCodesVS> type
      The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters

    • appContext

      protected StringType appContext
      An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it.

  • Constructor Details

  • Method Details

    • getLabelElement

      public StringType getLabelElement()
      Returns:
      label (Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

    • hasLabelElement

      public boolean hasLabelElement()

    • hasLabel

      public boolean hasLabel()

    • setLabelElement

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setLabelElement(StringType value)
      Parameters:
      value - label (Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

    • getLabel

      public String getLabel()
      Returns:
      Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).

    • setLabel

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setLabel(String value)
      Parameters:
      value - Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).

    • getUrlElement

      public UrlType getUrlElement()
      Returns:
      url (URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • hasUrlElement

      public boolean hasUrlElement()

    • hasUrl

      public boolean hasUrl()

    • setUrlElement

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setUrlElement(UrlType value)
      Parameters:
      value - url (URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • getUrl

      public String getUrl()
      Returns:
      URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash.

    • setUrl

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setUrl(String value)
      Parameters:
      value - URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash.

    • getTypeElement

      public Enumeration<CDSHooksResponse.CDSLinkTypeCodesVS> getTypeElement()
      Returns:
      type (The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

    • hasTypeElement

      public boolean hasTypeElement()

    • hasType

      public boolean hasType()

    • setTypeElement

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setTypeElement(Enumeration<CDSHooksResponse.CDSLinkTypeCodesVS> value)
      Parameters:
      value - type (The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

    • getType

      public CDSHooksResponse.CDSLinkTypeCodesVS getType()
      Returns:
      The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters

    • setType

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setType(CDSHooksResponse.CDSLinkTypeCodesVS value)
      Parameters:
      value - The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters

    • getAppContextElement

      public StringType getAppContextElement()
      Returns:
      appContext (An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it.). This is the underlying object with id, value and extensions. The accessor "getAppContext" gives direct access to the value

    • hasAppContextElement

      public boolean hasAppContextElement()

    • hasAppContext

      public boolean hasAppContext()

    • setAppContextElement

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setAppContextElement(StringType value)
      Parameters:
      value - appContext (An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it.). This is the underlying object with id, value and extensions. The accessor "getAppContext" gives direct access to the value

    • getAppContext

      public String getAppContext()
      Returns:
      An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it.

    • setAppContext

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent setAppContext(String value)
      Parameters:
      value - An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it.

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class CDSHooksElement

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class CDSHooksElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class CDSHooksElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class CDSHooksElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class CDSHooksElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class CDSHooksElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class CDSHooksElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class CDSHooksElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • copy

      public CDSHooksResponse.CDSHooksResponseCardsLinksComponent copy()
      Specified by:
      copy in class CDSHooksElement

    • copyValues

      public void copyValues(CDSHooksResponse.CDSHooksResponseCardsLinksComponent dst)

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class CDSHooksElement

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class CDSHooksElement

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class CDSHooksElement

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class CDSHooksElement
      Returns:
      the FHIR type name of the instance (not the java class name)