- * Concrete Implementations: This interface is often returned and/or accepted by methods in HAPI's API
- * where either {@link ca.uhn.fhir.model.primitive.IdDt} (the HAPI structure ID type) or
- * org.hl7.fhir.instance.model.IdType
(the RI structure ID type) will be used, depending on
- * which version of the strctures your application is using.
- *
http://example.com/fhir/Patient/123/_history/55
- */
- String getBaseUrl();
-
- /**
- * 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".
- */
- String getIdPart();
-
- /**
- * Returns the ID part of this ID (e.g. in the ID http://example.com/Patient/123/_history/456 this would be the
- * part "123") parsed as a {@link Long}.
- *
- * @throws NumberFormatException If the value can't be parsed as a long
- */
- Long getIdPartAsLong();
-
- String getResourceType();
-
- /**
- * 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 {@link #getIdPart()} to get just the ID portion.
- *
- * @see #getIdPart()
- */
- String getValue();
-
- String getVersionIdPart();
-
- /**
- * 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 {@link Long}.
- *
- * @throws NumberFormatException If the value can't be parsed as a long
- */
- Long getVersionIdPartAsLong();
-
- boolean hasBaseUrl();
-
- /**
- * 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
- */
- boolean hasIdPart();
-
- boolean hasResourceType();
-
- boolean hasVersionIdPart();
-
- /**
- * Returns true
if this ID contains an absolute URL (in other words, a URL starting with "http://" or "https://"
- */
- boolean isAbsolute();
-
- boolean isEmpty();
-
- /**
- * Returns true
if the {@link #getIdPart() 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}
- *
true
if the {@link #getIdPart() ID part of this object} contains
- * only numbers
- */
- boolean isIdPartValidLong();
-
- /**
- * Returns true
if the ID is a local reference (in other words, it begins with the '#' character)
- */
- boolean isLocal();
-
- /**
- * Returns true
if the {@link #getVersionIdPart() version ID part of this object} contains
- * only numbers
- */
- boolean isVersionIdPartValidLong();
-
- IIdType setValue(String theString);
-
- IIdType toUnqualified();
-
- IIdType toUnqualifiedVersionless();
-
- IIdType toVersionless();
-
- IIdType withResourceType(String theResName);
-
- IIdType withServerBase(String theServerBase, String theResourceName);
-
- IIdType withVersion(String theVersion);
-
-}