IdDt (HAPI FHIR - Core Library 4.0.1 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.api.BasePrimitive<String>
    - - ca.uhn.fhir.model.primitive.UriDt
      - ca.uhn.fhir.model.primitive.IdDt

All Implemented Interfaces:

IDatatype, IElement, IIdentifiableElement, IPrimitiveDatatype<String>, ISupportsUndeclaredExtensions, Externalizable, Serializable, IBase, IBaseDatatype, IIdType, IPrimitiveType<String>
```
public class IdDt
extends UriDt
implements IIdType
```
Represents the FHIR ID type. This is the actual resource ID, meaning the ID that will be used in RESTful URLs, Resource References, etc. to represent a specific instance of a resource.

Description: A whole number in the range 0 to 2^64-1 (optionally represented in hex), a uuid, an oid, or any other combination of lowercase letters, numerals, "-" and ".", with a length limit of 36 characters.

regex: [a-z-Z0-9\-\.]{1,36}

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IdDt()` Create a new empty ID
`IdDt(BigDecimal thePid)` Create a new ID, using a BigDecimal input.
`IdDt(long theId)` Create a new ID using a long
`IdDt(String theValue)` Create a new ID using a string.
`IdDt(String theResourceType, BigDecimal theIdPart)` Constructor
`IdDt(String theResourceType, Long theIdPart)` Constructor
`IdDt(String theResourceType, String theId)` Constructor
`IdDt(String theResourceType, String theId, String theVersionId)` Constructor
`IdDt(String theBaseUrl, String theResourceType, String theId, String theVersionId)` Constructor
`IdDt(UriDt theUrl)` Creates an ID based on a given URL

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`applyTo(IBaseResource theResouce)`
`BigDecimal`	`asBigDecimal()` Deprecated. Use `getIdPartAsBigDecimal()` instead (this method was deprocated because its name is ambiguous)
`boolean`	`equals(Object theArg0)`
`boolean`	`equalsIgnoreBase(IdDt theId)` Returns true if this IdDt matches the given IdDt in terms of resource type and ID, but ignores the URL base
`String`	`getBaseUrl()` Returns the portion of this resource ID which corresponds to the server base URL.
`String`	`getIdPart()` Returns only the logical ID part of this ID.
`BigDecimal`	`getIdPartAsBigDecimal()` Returns the unqualified portion of this ID as a big decimal, or `null` if the value is null
`Long`	`getIdPartAsLong()` Returns the unqualified portion of this ID as a `Long`, or `null` if the value is null
`String`	`getResourceType()`
`String`	`getValue()` Returns the value of this ID.
`String`	`getValueAsString()`
`String`	`getVersionIdPart()`
`Long`	`getVersionIdPartAsLong()` Returns the version ID part of this ID (e.g.
`boolean`	`hasBaseUrl()` Returns true if this ID has a base url
`int`	`hashCode()`
`boolean`	`hasIdPart()` Returns `true` if this ID contains an actual ID part.
`boolean`	`hasResourceType()`
`boolean`	`hasVersionIdPart()`
`boolean`	`isAbsolute()` Returns `true` if this ID contains an absolute URL (in other words, a URL starting with "http://" or "https://"
`boolean`	`isEmpty()`
`boolean`	`isIdPartValid()` Returns `true` if the `ID part of this object` is valid according to the FHIR rules for valid IDs.
`boolean`	`isIdPartValidLong()` Returns `true` if the `ID part of this object` contains only numbers
`boolean`	`isLocal()` Returns `true` if the ID is a local reference (in other words, it begins with the '#' character)
`static boolean`	`isValidLong(String id)`
`boolean`	`isVersionIdPartValidLong()` Returns `true` if the `version ID part of this object` contains only numbers
`static IdDt`	`newRandomUuid()` Construct a new ID with with form "urn:uuid:[UUID]" where [UUID] is a new, randomly created UUID generated by `UUID.randomUUID()`
`static IdDt`	`of(IBaseResource theResouce)` Retrieves the ID from the given resource instance
`void`	`setId(IdDt theId)` Deprecated.
`IIdType`	`setParts(String theBaseUrl, String theResourceType, String theIdPart, String theVersionIdPart)` Sets the value of this ID by combining all of the individual parts.
`IdDt`	`setValue(String theValue)` Set the value
`void`	`setValueAsString(String theValue)` Set the value
`String`	`toString()`
`IdDt`	`toUnqualified()` Returns a new IdDt containing this IdDt's values but with no server base URL if one is present in this IdDt.
`IdDt`	`toUnqualifiedVersionless()`
`IdDt`	`toVersionless()`
`IdDt`	`withResourceType(String theResourceName)` Returns a copy of this object, but with a different `resource type` (or if this object does not have a resource type currently, returns a copy of this object with the given resource type).
`IdDt`	`withServerBase(String theServerBase, String theResourceType)` Returns a view of this ID as a fully qualified URL, given a server base and resource name (which will only be used if the ID does not already contain those respective parts).
`IdDt`	`withVersion(String theVersion)` Creates a new instance of this ID which is identical, but refers to the specific version of this resource ID noted by theVersion.

Methods inherited from class ca.uhn.fhir.model.primitive.UriDt
encode, equals, fromOid, parse

Methods inherited from class ca.uhn.fhir.model.api.BasePrimitive
hasValue, readExternal, updateStringValue, writeExternal

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, isBaseEmpty

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IPrimitiveType
hasValue

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Constructor Detail
  - IdDt
```
public IdDt()
```
    Create a new empty ID
  - IdDt
```
public IdDt(BigDecimal thePid)
```
    Create a new ID, using a BigDecimal input. Uses BigDecimal.toPlainString() to generate the string representation.
  - IdDt
```
public IdDt(long theId)
```
    Create a new ID using a long
  - IdDt
```
public IdDt(String theValue)
```
    Create a new ID using a string. This String may contain a simple ID (e.g. "1234") or it may contain a complete URL (http://example.com/fhir/Patient/1234).
    
    Description: A whole number in the range 0 to 2^64-1 (optionally represented in hex), a uuid, an oid, or any other combination of lowercase letters, numerals, "-" and ".", with a length limit of 36 characters.
    
    regex: [a-z0-9\-\.]{1,36}
  - IdDt
```
public IdDt(String theResourceType,
            BigDecimal theIdPart)
```
    Constructor
    
    Parameters:
    
    theResourceType - The resource type (e.g. "Patient")
    
    theIdPart - The ID (e.g. "123")
  - IdDt
```
public IdDt(String theResourceType,
            Long theIdPart)
```
    Constructor
    
    Parameters:
    
    theResourceType - The resource type (e.g. "Patient")
    
    theIdPart - The ID (e.g. "123")
  - IdDt
```
public IdDt(String theResourceType,
            String theId)
```
    Constructor
    
    Parameters:
    
    theResourceType - The resource type (e.g. "Patient")
    
    theId - The ID (e.g. "123")
  - IdDt
```
public IdDt(String theResourceType,
            String theId,
            String theVersionId)
```
    Constructor
    
    Parameters:
    
    theResourceType - The resource type (e.g. "Patient")
    
    theId - The ID (e.g. "123")
    
    theVersionId - The version ID ("e.g. "456")
  - IdDt
```
public IdDt(String theBaseUrl,
            String theResourceType,
            String theId,
            String theVersionId)
```
    Constructor
    
    Parameters:
    
    theBaseUrl - The server base URL (e.g. "http://example.com/fhir")
    
    theResourceType - The resource type (e.g. "Patient")
    
    theId - The ID (e.g. "123")
    
    theVersionId - The version ID ("e.g. "456")
  - IdDt
```
public IdDt(UriDt theUrl)
```
    Creates an ID based on a given URL
- Method Detail
  - applyTo
```
public void applyTo(IBaseResource theResouce)
```
    Specified by:
    
    applyTo in interface IIdType
  - asBigDecimal
```
@Deprecated
public BigDecimal asBigDecimal()
```
    Deprecated. Use getIdPartAsBigDecimal() instead (this method was deprocated because its name is ambiguous)
  - equals
```
public boolean equals(Object theArg0)
```
    Overrides:
    
    equals in class UriDt
  - equalsIgnoreBase
```
public boolean equalsIgnoreBase(IdDt theId)
```
    Returns true if this IdDt matches the given IdDt in terms of resource type and ID, but ignores the URL base
  - getBaseUrl
```
public String getBaseUrl()
```
    Returns the portion of this resource ID which corresponds to the server base URL. For example given the resource ID http://example.com/fhir/Patient/123 the base URL would be http://example.com/fhir.
    This method may return null if the ID contains no base (e.g. "Patient/123")
    
    Specified by:
    
    getBaseUrl in interface IIdType
  - getIdPart
```
public String getIdPart()
```
    Returns only the logical ID part of this ID. For example, given the ID "http://example,.com/fhir/Patient/123/_history/456", this method would return "123".
    
    Specified by:
    
    getIdPart in interface IIdType
  - getIdPartAsBigDecimal
```
public BigDecimal getIdPartAsBigDecimal()
```
    Returns the unqualified portion of this ID as a big decimal, or null if the value is null
    
    Throws:
    
    NumberFormatException - If the value is not a valid BigDecimal
  - getIdPartAsLong
```
public Long getIdPartAsLong()
```
    Returns the unqualified portion of this ID as a Long, or null if the value is null
    
    Specified by:
    
    getIdPartAsLong in interface IIdType
    
    Throws:
    
    NumberFormatException - If the value is not a valid Long
  - getResourceType
```
public String getResourceType()
```
    Specified by:
    
    getResourceType in interface IIdType
  - getValue
```
public String getValue()
```
    Returns the value of this ID. Note that this value may be a fully qualified URL, a relative/partial URL, or a simple ID. Use getIdPart() to get just the ID portion.
    
    Specified by:
    
    getValue in interface IPrimitiveDatatype<String>
    
    Specified by:
    
    getValue in interface IIdType
    
    Specified by:
    
    getValue in interface IPrimitiveType<String>
    
    Overrides:
    
    getValue in class BasePrimitive<String>
    
    See Also:
    
    getIdPart()
  - setValue
```
public IdDt setValue(String theValue)
              throws DataFormatException
```
    Set the value
    
    Description: A whole number in the range 0 to 2^64-1 (optionally represented in hex), a uuid, an oid, or any other combination of lowercase letters, numerals, "-" and ".", with a length limit of 36 characters.
    
    regex: [a-z0-9\-\.]{1,36}
    
    Specified by:
    
    setValue in interface IPrimitiveDatatype<String>
    
    Specified by:
    
    setValue in interface IIdType
    
    Specified by:
    
    setValue in interface IPrimitiveType<String>
    
    Overrides:
    
    setValue in class BasePrimitive<String>
    
    Throws:
    
    DataFormatException
  - getValueAsString
```
public String getValueAsString()
```
    Specified by:
    
    getValueAsString in interface IPrimitiveDatatype<String>
    
    Specified by:
    
    getValueAsString in interface IPrimitiveType<String>
    
    Overrides:
    
    getValueAsString in class BasePrimitive<String>
  - setValueAsString
```
public void setValueAsString(String theValue)
                      throws DataFormatException
```
    Set the value
    
    Description: A whole number in the range 0 to 2^64-1 (optionally represented in hex), a uuid, an oid, or any other combination of lowercase letters, numerals, "-" and ".", with a length limit of 36 characters.
    
    regex: [a-z0-9\-\.]{1,36}
    
    Specified by:
    
    setValueAsString in interface IPrimitiveDatatype<String>
    
    Specified by:
    
    setValueAsString in interface IPrimitiveType<String>
    
    Overrides:
    
    setValueAsString in class BasePrimitive<String>
    
    Throws:
    
    DataFormatException
  - getVersionIdPart
```
public String getVersionIdPart()
```
    Specified by:
    
    getVersionIdPart in interface IIdType
  - getVersionIdPartAsLong
```
public Long getVersionIdPartAsLong()
```
    Description copied from interface: IIdType
    
    Returns the version ID part of this ID (e.g. in the ID http://example.com/Patient/123/_history/456 this would be the part "456") parsed as a Long.
    
    Specified by:
    
    getVersionIdPartAsLong in interface IIdType
  - hasBaseUrl
```
public boolean hasBaseUrl()
```
    Returns true if this ID has a base url
    
    Specified by:
    
    hasBaseUrl in interface IIdType
    
    See Also:
    
    getBaseUrl()
  - hasIdPart
```
public boolean hasIdPart()
```
    Description copied from interface: IIdType
    
    Returns true if this ID contains an actual ID part. For example, the ID part is the '123' in the following ID: http://example.com/fhir/Patient/123/_history/55
    
    Specified by:
    
    hasIdPart in interface IIdType
  - hasResourceType
```
public boolean hasResourceType()
```
    Specified by:
    
    hasResourceType in interface IIdType
  - hasVersionIdPart
```
public boolean hasVersionIdPart()
```
    Specified by:
    
    hasVersionIdPart in interface IIdType
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class UriDt
  - isAbsolute
```
public boolean isAbsolute()
```
    Returns true if this ID contains an absolute URL (in other words, a URL starting with "http://" or "https://"
    
    Specified by:
    
    isAbsolute in interface IIdType
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Specified by:
    
    isEmpty in interface IIdType
    
    Overrides:
    
    isEmpty in class BasePrimitive<String>
  - isIdPartValid
```
public boolean isIdPartValid()
```
    Description copied from interface: IIdType
    
    Returns true if the ID part of this object is valid according to the FHIR rules for valid IDs.
    The FHIR specification states: Any combination of upper or lower case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.', with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) regex: [A-Za-z0-9\-\.]{1,64}
    
    Specified by:
    
    isIdPartValid in interface IIdType
  - isIdPartValidLong
```
public boolean isIdPartValidLong()
```
    Description copied from interface: IIdType
    
    Returns true if the ID part of this object contains only numbers
    
    Specified by:
    
    isIdPartValidLong in interface IIdType
  - isLocal
```
public boolean isLocal()
```
    Returns true if the ID is a local reference (in other words, it begins with the '#' character)
    
    Specified by:
    
    isLocal in interface IIdType
  - isVersionIdPartValidLong
```
public boolean isVersionIdPartValidLong()
```
    Description copied from interface: IIdType
    
    Returns true if the version ID part of this object contains only numbers
    
    Specified by:
    
    isVersionIdPartValidLong in interface IIdType
  - setId
```
@Deprecated
public void setId(IdDt theId)
```
    Deprecated.
    
    Copies the value from the given IdDt to this IdDt. It is generally not neccesary to use this method but it is provided for consistency with the rest of the API.
    
    Specified by:
    
    setId in interface IIdentifiableElement
    
    Overrides:
    
    setId in class BaseIdentifiableElement
  - setParts
```
public IIdType setParts(String theBaseUrl,
                        String theResourceType,
                        String theIdPart,
                        String theVersionIdPart)
```
    Description copied from interface: IIdType
    Sets the value of this ID by combining all of the individual parts.
    Required parameters: The following rules apply to the parameters of this method (in this case, populated means a non-empty string and not populated means null or an empty string)
    - All values may be not populated
    - If theVersionIdPart is populated, theResourceType and theIdPart must be populated
    - If theBaseUrl is populated and theIdPart is populated, theResourceType must be populated
    Specified by:
    
    setParts in interface IIdType
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class BasePrimitive<String>
  - toUnqualified
```
public IdDt toUnqualified()
```
    Returns a new IdDt containing this IdDt's values but with no server base URL if one is present in this IdDt. For example, if this IdDt contains the ID "http://foo/Patient/1", this method will return a new IdDt containing ID "Patient/1".
    
    Specified by:
    
    toUnqualified in interface IIdType
  - toUnqualifiedVersionless
```
public IdDt toUnqualifiedVersionless()
```
    Specified by:
    
    toUnqualifiedVersionless in interface IIdType
  - toVersionless
```
public IdDt toVersionless()
```
    Specified by:
    
    toVersionless in interface IIdType
  - withResourceType
```
public IdDt withResourceType(String theResourceName)
```
    Description copied from interface: IIdType
    
    Returns a copy of this object, but with a different resource type (or if this object does not have a resource type currently, returns a copy of this object with the given resource type).
    Note that if this object represents a local reference (e.g. #foo) or a URN (e.g. urn:oid:1.2.3.4) this method will simply return a copy of this object with no modifications.
    
    Specified by:
    
    withResourceType in interface IIdType
  - withServerBase
```
public IdDt withServerBase(String theServerBase,
                           String theResourceType)
```
    Returns a view of this ID as a fully qualified URL, given a server base and resource name (which will only be used if the ID does not already contain those respective parts). Essentially, because IdDt can contain either a complete URL or a partial one (or even jut a simple ID), this method may be used to translate into a complete URL.
    
    Specified by:
    
    withServerBase in interface IIdType
    
    Parameters:
    
    theServerBase - The server base (e.g. "http://example.com/fhir")
    
    theResourceType - The resource name (e.g. "Patient")
    
    Returns:
    
    A fully qualified URL for this ID (e.g. "http://example.com/fhir/Patient/1")
  - withVersion
```
public IdDt withVersion(String theVersion)
```
    Creates a new instance of this ID which is identical, but refers to the specific version of this resource ID noted by theVersion.
    
    Specified by:
    
    withVersion in interface IIdType
    
    Parameters:
    
    theVersion - The actual version string, e.g. "1". If theVersion is blank or null, returns the same as toVersionless()}
    
    Returns:
    
    A new instance of IdDt which is identical, but refers to the specific version of this resource ID noted by theVersion.
  - isValidLong
```
public static boolean isValidLong(String id)
```
  - newRandomUuid
```
public static IdDt newRandomUuid()
```
    Construct a new ID with with form "urn:uuid:[UUID]" where [UUID] is a new, randomly created UUID generated by UUID.randomUUID()
  - of
```
public static IdDt of(IBaseResource theResouce)
```
    Retrieves the ID from the given resource instance

Class IdDt

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.primitive.UriDt

Methods inherited from class ca.uhn.fhir.model.api.BasePrimitive

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IPrimitiveType

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Constructor Detail

IdDt

IdDt

IdDt

IdDt

IdDt

IdDt

IdDt

IdDt

IdDt

IdDt

Method Detail

applyTo

asBigDecimal

equals

equalsIgnoreBase

getBaseUrl

getIdPart

getIdPartAsBigDecimal

getIdPartAsLong

getResourceType

getValue

setValue

getValueAsString

setValueAsString

getVersionIdPart

getVersionIdPartAsLong

hasBaseUrl

hasIdPart

hasResourceType

hasVersionIdPart

hashCode

isAbsolute

isEmpty

isIdPartValid

isIdPartValidLong

isLocal

isVersionIdPartValidLong

setId

setParts

toString

toUnqualified

toUnqualifiedVersionless

toVersionless

withResourceType

withServerBase

withVersion

isValidLong

newRandomUuid

of