Package org.hl7.fhir.r4.model
Class Identifier
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.Element
org.hl7.fhir.r4.model.Type
org.hl7.fhir.r4.model.Identifier
- 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.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.ICompositeType
An identifier - identifies some entity uniquely and unambiguously. Typically
this is used for business identifiers.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Reference
Organization that issued/manages the identifier.protected Organization
The actual object that is the target of the reference (Organization that issued/manages the identifier.)protected Period
Time period during which identifier is/was valid for use.protected UriType
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.protected CodeableConcept
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.protected Enumeration
<Identifier.IdentifierUse> The purpose of this identifier.protected StringType
The portion of the identifier typically relevant to the user and which is unique within the context of the system. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
copyValues
(Identifier dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) getUse()
getValue()
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
hasUse()
boolean
boolean
hasValue()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAssigner
(Reference value) setAssignerTarget
(Organization value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setSystemElement
(UriType value) setType
(CodeableConcept value) setUse
(Identifier.IdentifierUse value) setValueElement
(StringType value) protected Identifier
Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
-
Field Details
-
use
The purpose of this identifier. -
type
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. -
system
Establishes the namespace for the value - that is, a URL that describes a set values that are unique. -
value
The portion of the identifier typically relevant to the user and which is unique within the context of the system. -
period
Time period during which identifier is/was valid for use. -
assigner
Organization that issued/manages the identifier. -
assignerTarget
The actual object that is the target of the reference (Organization that issued/manages the identifier.)
-
-
Constructor Details
-
Identifier
public Identifier()Constructor
-
-
Method Details
-
getUseElement
- Returns:
use
(The purpose of this identifier.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
hasUseElement
-
hasUse
-
setUseElement
- Parameters:
value
-use
(The purpose of this identifier.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
getUse
- Returns:
- The purpose of this identifier.
-
setUse
- Parameters:
value
- The purpose of this identifier.
-
getType
- Returns:
type
(A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.)
-
hasType
-
setType
- Parameters:
value
-type
(A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.)
-
getSystemElement
- Returns:
system
(Establishes the namespace for the value - that is, a URL that describes a set values that are unique.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
-
hasSystemElement
-
hasSystem
-
setSystemElement
- Parameters:
value
-system
(Establishes the namespace for the value - that is, a URL that describes a set values that are unique.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
-
getSystem
- Returns:
- Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
-
setSystem
- Parameters:
value
- Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
-
getValueElement
- Returns:
value
(The portion of the identifier typically relevant to the user and which is unique within the context of the system.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
-
hasValueElement
-
hasValue
-
setValueElement
- Parameters:
value
-value
(The portion of the identifier typically relevant to the user and which is unique within the context of the system.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
-
getValue
- Returns:
- The portion of the identifier typically relevant to the user and which is unique within the context of the system.
-
setValue
- Parameters:
value
- The portion of the identifier typically relevant to the user and which is unique within the context of the system.
-
getPeriod
- Returns:
period
(Time period during which identifier is/was valid for use.)
-
hasPeriod
-
setPeriod
- Parameters:
value
-period
(Time period during which identifier is/was valid for use.)
-
getAssigner
- Returns:
assigner
(Organization that issued/manages the identifier.)
-
hasAssigner
-
setAssigner
- Parameters:
value
-assigner
(Organization that issued/manages the identifier.)
-
getAssignerTarget
- Returns:
assigner
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Organization that issued/manages the identifier.)
-
setAssignerTarget
- Parameters:
value
-assigner
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Organization that issued/manages the identifier.)
-
listChildren
- Overrides:
listChildren
in classElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classElement
- 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 classElement
- 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 classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
-
fhirType
-
copy
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classElement
-
equalsShallow
- Overrides:
equalsShallow
in classElement
-
isEmpty
-