Class Extension

  • 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.IBaseElement, org.hl7.fhir.instance.model.api.IBaseExtension<Extension,​DataType>, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

    public class Extension
    extends BaseExtension
    implements org.hl7.fhir.instance.model.api.IBaseExtension<Extension,​DataType>, org.hl7.fhir.instance.model.api.IBaseHasExtensions
    Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        Source of the definition for the extension code - a logical name or a URL.
      • value

        protected DataType value
        Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
    • Constructor Detail

      • Extension

        public Extension​(String theUrl,
                         org.hl7.fhir.instance.model.api.IBaseDatatype theValue)
        Constructor
    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (Source of the definition for the extension code - a logical name or a URL.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • hasUrl

        public boolean hasUrl()
      • setUrlElement

        public Extension setUrlElement​(UriType value)
        Parameters:
        value - url (Source of the definition for the extension code - a logical name or a URL.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • getUrl

        public String getUrl()
        Specified by:
        getUrl in interface org.hl7.fhir.instance.model.api.IBaseExtension<Extension,​DataType>
        Returns:
        Source of the definition for the extension code - a logical name or a URL.
      • setUrl

        public Extension setUrl​(String value)
        Specified by:
        setUrl in interface org.hl7.fhir.instance.model.api.IBaseExtension<Extension,​DataType>
        Parameters:
        value - Source of the definition for the extension code - a logical name or a URL.
      • getValue

        public DataType getValue()
        Specified by:
        getValue in interface org.hl7.fhir.instance.model.api.IBaseExtension<Extension,​DataType>
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
      • getValueBase64BinaryType

        public Base64BinaryType getValueBase64BinaryType()
                                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueBooleanType

        public BooleanType getValueBooleanType()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueCanonicalType

        public CanonicalType getValueCanonicalType()
                                            throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueCodeType

        public CodeType getValueCodeType()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueDateType

        public DateType getValueDateType()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueDateTimeType

        public DateTimeType getValueDateTimeType()
                                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueDecimalType

        public DecimalType getValueDecimalType()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueIdType

        public IdType getValueIdType()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueInstantType

        public InstantType getValueInstantType()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueIntegerType

        public IntegerType getValueIntegerType()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueMarkdownType

        public MarkdownType getValueMarkdownType()
                                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueOidType

        public OidType getValueOidType()
                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValuePositiveIntType

        public PositiveIntType getValuePositiveIntType()
                                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueStringType

        public StringType getValueStringType()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueTimeType

        public TimeType getValueTimeType()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueUnsignedIntType

        public UnsignedIntType getValueUnsignedIntType()
                                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueUriType

        public UriType getValueUriType()
                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueUrlType

        public UrlType getValueUrlType()
                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueUuidType

        public UuidType getValueUuidType()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueAddress

        public Address getValueAddress()
                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueAge

        public Age getValueAge()
                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueAnnotation

        public Annotation getValueAnnotation()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueAttachment

        public Attachment getValueAttachment()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueCodeableConcept

        public CodeableConcept getValueCodeableConcept()
                                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueCodeableReference

        public CodeableReference getValueCodeableReference()
                                                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueCoding

        public Coding getValueCoding()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueContactPoint

        public ContactPoint getValueContactPoint()
                                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueCount

        public Count getValueCount()
                            throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueDistance

        public Distance getValueDistance()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueDuration

        public Duration getValueDuration()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueHumanName

        public HumanName getValueHumanName()
                                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueIdentifier

        public Identifier getValueIdentifier()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueMoney

        public Money getValueMoney()
                            throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValuePeriod

        public Period getValuePeriod()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueQuantity

        public Quantity getValueQuantity()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueRange

        public Range getValueRange()
                            throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueRatio

        public Ratio getValueRatio()
                            throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueRatioRange

        public RatioRange getValueRatioRange()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueReference

        public Reference getValueReference()
                                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueSampledData

        public SampledData getValueSampledData()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueSignature

        public Signature getValueSignature()
                                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueTiming

        public Timing getValueTiming()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueContactDetail

        public ContactDetail getValueContactDetail()
                                            throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueContributor

        public Contributor getValueContributor()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueDataRequirement

        public DataRequirement getValueDataRequirement()
                                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueExpression

        public Expression getValueExpression()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueParameterDefinition

        public ParameterDefinition getValueParameterDefinition()
                                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueRelatedArtifact

        public RelatedArtifact getValueRelatedArtifact()
                                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueTriggerDefinition

        public TriggerDefinition getValueTriggerDefinition()
                                                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueUsageContext

        public UsageContext getValueUsageContext()
                                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueDosage

        public Dosage getValueDosage()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getValueMeta

        public Meta getValueMeta()
                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • setValue

        public Extension setValue​(DataType value)
        Specified by:
        setValue in class BaseExtension
        Parameters:
        value - value (Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).)
      • getProperty

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

        public Base addChild​(String name)
                      throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        addChild in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • fhirType

        public String fhirType()
        Specified by:
        fhirType in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        fhirType in class DataType
      • isEmpty

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