IdType (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.Type
    - - org.hl7.fhir.dstu3.model.PrimitiveType<String>
      - org.hl7.fhir.dstu3.model.UriType
        
        org.hl7.fhir.dstu3.model.IdType

All Implemented Interfaces:

IElement, Externalizable, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, IIdType, IPrimitiveType<String>
```
public final class IdType
extends UriType
implements IPrimitiveType<String>, IIdType
```
This class represents the logical identity for a resource, or as much of that identity is known. In FHIR, every resource must have a "logical ID" which is defined by the FHIR specification as:
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

This class contains that logical ID, and can optionally also contain a relative or absolute URL representing the resource identity. For example, the following are all valid values for IdType, and all might represent the same resource:
- 123 (just a resource's ID)
- Patient/123 (a relative identity)
- http://example.com/Patient/123 (an absolute identity)
- http://example.com/Patient/123/_history/1 (an absolute identity with a version id)
- Patient/123/_history/1 (a relative identity with a version id)
In most situations, you only need to populate the resource's ID (e.g. 123) in resources you are constructing and the encoder will infer the rest from the context in which the object is being used. On the other hand, the parser will always try to populate the complete absolute identity on objects it creates as a convenience.

Regex for ID: [a-z0-9\-\.]{1,36}
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_LENGTH
This is the maximum length for the ID
- Fields inherited from class org.hl7.fhir.dstu3.model.Element
  extension, id

Fields
Modifier and Type	Field and Description
`static int`	`MAX_LENGTH` This is the maximum length for the ID

Constructor Summary

Constructors
Constructor and Description
`IdType()` Create a new empty ID
`IdType(BigDecimal thePid)` Create a new ID, using a BigDecimal input.
`IdType(long theId)` Create a new ID using a long
`IdType(String theValue)` Create a new ID using a string.
`IdType(String theResourceType, BigDecimal theIdPart)` Constructor
`IdType(String theResourceType, Long theIdPart)` Constructor
`IdType(String theResourceType, String theId)` Constructor
`IdType(String theResourceType, String theId, String theVersionId)` Constructor
`IdType(String theBaseUrl, String theResourceType, String theId, String theVersionId)` Constructor
`IdType(UriType 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)
`IdType`	`copy()`
`boolean`	`equals(Object theArg0)`
`boolean`	`equalsIgnoreBase(IdType theId)` Returns true if this IdType matches the given IdType in terms of resource type and ID, but ignores the URL base
`String`	`fhirType()`
`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()`
`boolean`	`hasBaseUrl()` Returns true if this ID has a base url
`int`	`hashCode()`
`boolean`	`hasIdPart()`
`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()`
`boolean`	`isIdPartValidLong()` Returns `true` if the unqualified ID is a valid `Long` value (in other words, it consists only of digits)
`boolean`	`isLocal()` Returns `true` if the ID is a local reference (in other words, it begins with the '#' character)
`boolean`	`isVersionIdPartValidLong()`
`static IdType`	`newRandomUuid()` Construct a new ID with with form "urn:uuid:[UUID]" where [UUID] is a new, randomly created UUID generated by `UUID.randomUUID()`
`static IdType`	`of(IBaseResource theResouce)` Retrieves the ID from the given resource instance
`IIdType`	`setParts(String theBaseUrl, String theResourceType, String theIdPart, String theVersionIdPart)`
`IdType`	`setValue(String theValue)` Set the value
`void`	`setValueAsString(String theValue)` Set the value
`String`	`toString()`
`IdType`	`toUnqualified()` Returns a new IdType containing this IdType's values but with no server base URL if one is present in this IdType.
`IdType`	`toUnqualifiedVersionless()`
`IdType`	`toVersionless()`
`IdType`	`withResourceType(String theResourceName)`
`IdType`	`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).
`IdType`	`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 org.hl7.fhir.dstu3.model.UriType
encode, equals, equalsDeep, fromOid, parse

Methods inherited from class org.hl7.fhir.dstu3.model.PrimitiveType
asStringValue, equalsShallow, fromStringValue, hasValue, isPrimitive, primitiveValue, readExternal, typedCopy, updateStringValue, writeExternal

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addChild, addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, getProperty, getTypesForProperty, hasExtension, hasExtension, hasId, hasIdElement, listChildren, makeProperty, setExtension, setId, setIdBase, setIdElement, setProperty, setProperty

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isResource, listChildrenByName, listChildrenByName, setUserData, setUserDataINN

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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

- Field Detail
  - MAX_LENGTH
```
public static final int MAX_LENGTH
```
    This is the maximum length for the ID
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IdType
```
public IdType()
```
    Create a new empty ID
  - IdType
```
public IdType(BigDecimal thePid)
```
    Create a new ID, using a BigDecimal input. Uses BigDecimal.toPlainString() to generate the string representation.
  - IdType
```
public IdType(long theId)
```
    Create a new ID using a long
  - IdType
```
public IdType(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}
  - IdType
```
public IdType(String theResourceType,
              BigDecimal theIdPart)
```
    Constructor
    
    Parameters:
    
    theResourceType - The resource type (e.g. "Patient")
    
    theIdPart - The ID (e.g. "123")
  - IdType
```
public IdType(String theResourceType,
              Long theIdPart)
```
    Constructor
    
    Parameters:
    
    theResourceType - The resource type (e.g. "Patient")
    
    theIdPart - The ID (e.g. "123")
  - IdType
```
public IdType(String theResourceType,
              String theId)
```
    Constructor
    
    Parameters:
    
    theResourceType - The resource type (e.g. "Patient")
    
    theId - The ID (e.g. "123")
  - IdType
```
public IdType(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")
  - IdType
```
public IdType(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")
  - IdType
```
public IdType(UriType 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)
  - copy
```
public IdType copy()
```
    Overrides:
    
    copy in class UriType
  - equals
```
public boolean equals(Object theArg0)
```
    Overrides:
    
    equals in class Object
  - equalsIgnoreBase
```
public boolean equalsIgnoreBase(IdType theId)
```
    Returns true if this IdType matches the given IdType 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 IIdType
    
    Specified by:
    
    getValue in interface IPrimitiveType<String>
    
    Overrides:
    
    getValue in class PrimitiveType<String>
    
    See Also:
    
    getIdPart()
  - getValueAsString
```
public String getValueAsString()
```
    Specified by:
    
    getValueAsString in interface IPrimitiveType<String>
    
    Overrides:
    
    getValueAsString in class PrimitiveType<String>
  - getVersionIdPart
```
public String getVersionIdPart()
```
    Specified by:
    
    getVersionIdPart in interface IIdType
  - getVersionIdPartAsLong
```
public Long getVersionIdPartAsLong()
```
    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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class UriType
  - hasIdPart
```
public boolean hasIdPart()
```
    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
  - 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 PrimitiveType<String>
  - isIdPartValid
```
public boolean isIdPartValid()
```
    Specified by:
    
    isIdPartValid in interface IIdType
  - isIdPartValidLong
```
public boolean isIdPartValidLong()
```
    Returns true if the unqualified ID is a valid Long value (in other words, it consists only of digits)
    
    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()
```
    Specified by:
    
    isVersionIdPartValidLong in interface IIdType
  - setValue
```
public IdType setValue(String theValue)
```
    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 IIdType
    
    Specified by:
    
    setValue in interface IPrimitiveType<String>
    
    Overrides:
    
    setValue in class PrimitiveType<String>
  - setValueAsString
```
public void setValueAsString(String theValue)
```
    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 IPrimitiveType<String>
    
    Overrides:
    
    setValueAsString in class PrimitiveType<String>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class PrimitiveType<String>
  - toUnqualified
```
public IdType toUnqualified()
```
    Returns a new IdType containing this IdType's values but with no server base URL if one is present in this IdType. For example, if this IdType contains the ID "http://foo/Patient/1", this method will return a new IdType containing ID "Patient/1".
    
    Specified by:
    
    toUnqualified in interface IIdType
  - toUnqualifiedVersionless
```
public IdType toUnqualifiedVersionless()
```
    Specified by:
    
    toUnqualifiedVersionless in interface IIdType
  - toVersionless
```
public IdType toVersionless()
```
    Specified by:
    
    toVersionless in interface IIdType
  - withResourceType
```
public IdType withResourceType(String theResourceName)
```
    Specified by:
    
    withResourceType in interface IIdType
  - withServerBase
```
public IdType 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 IdType 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 IdType 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"
    
    Returns:
    
    A new instance of IdType which is identical, but refers to the specific version of this resource ID noted by theVersion.
  - newRandomUuid
```
public static IdType 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 IdType of(IBaseResource theResouce)
```
    Retrieves the ID from the given resource instance
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class UriType
  - setParts
```
public IIdType setParts(String theBaseUrl,
                        String theResourceType,
                        String theIdPart,
                        String theVersionIdPart)
```
    Specified by:
    
    setParts in interface IIdType

Class IdType

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.UriType

Methods inherited from class org.hl7.fhir.dstu3.model.PrimitiveType

Methods inherited from class org.hl7.fhir.dstu3.model.Element

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

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

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

Field Detail

MAX_LENGTH

Constructor Detail

IdType

IdType

IdType

IdType

IdType

IdType

IdType

IdType

IdType

IdType

Method Detail

applyTo

asBigDecimal

copy

equals

equalsIgnoreBase

getBaseUrl

getIdPart

getIdPartAsBigDecimal

getIdPartAsLong

getResourceType

getValue

getValueAsString

getVersionIdPart

getVersionIdPartAsLong

hasBaseUrl

hashCode

hasIdPart

hasResourceType

hasVersionIdPart

isAbsolute

isEmpty

isIdPartValid

isIdPartValidLong

isLocal

isVersionIdPartValidLong

setValue

setValueAsString

toString

toUnqualified

toUnqualifiedVersionless

toVersionless

withResourceType

withServerBase

withVersion

newRandomUuid

of

fhirType

setParts