Class CatalogEntry
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.CatalogEntry
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class CatalogEntry extends DomainResource
Catalog entries are wrappers that contextualize items included in a catalog.Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CatalogEntry.Builder
static class
CatalogEntry.RelatedEntry
Used for example, to point to a substance, or to a device used to administer a medication.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static CatalogEntry.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<CodeableConcept>
getAdditionalCharacteristic()
Used for examplefor Out of Formulary, or any specifics.java.util.List<CodeableConcept>
getAdditionalClassification()
User for example for ATC classification, or.java.util.List<Identifier>
getAdditionalIdentifier()
Used in supporting related concepts, e.g.java.util.List<CodeableConcept>
getClassification()
Classes of devices, or ATC for medication.java.util.List<Identifier>
getIdentifier()
Used in supporting different identifiers for the same product, e.g.DateTime
getLastUpdated()
Typically date of issue is different from the beginning of the validity.Boolean
getOrderable()
Whether the entry represents an orderable item.Reference
getReferencedItem()
The item in a catalog or definition.java.util.List<CatalogEntry.RelatedEntry>
getRelatedEntry()
Used for example, to point to a substance, or to a device used to administer a medication.PublicationStatus
getStatus()
Used to support catalog exchange even for unsupported products, e.g.CodeableConcept
getType()
The type of item - medication, device, service, protocol or other.Period
getValidityPeriod()
The time period in which this catalog entry is expected to be active.DateTime
getValidTo()
The date until which this catalog entry is expected to be active.boolean
hasChildren()
int
hashCode()
CatalogEntry.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getType
public CodeableConcept getType()
The type of item - medication, device, service, protocol or other.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getOrderable
public Boolean getOrderable()
Whether the entry represents an orderable item.- Returns:
- An immutable object of type
Boolean
that is non-null.
-
getReferencedItem
public Reference getReferencedItem()
The item in a catalog or definition.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getAdditionalIdentifier
public java.util.List<Identifier> getAdditionalIdentifier()
Used in supporting related concepts, e.g. NDC to RxNorm.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getClassification
public java.util.List<CodeableConcept> getClassification()
Classes of devices, or ATC for medication.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getStatus
public PublicationStatus getStatus()
Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.- Returns:
- An immutable object of type
PublicationStatus
that may be null.
-
getValidityPeriod
public Period getValidityPeriod()
The time period in which this catalog entry is expected to be active.- Returns:
- An immutable object of type
Period
that may be null.
-
getValidTo
public DateTime getValidTo()
The date until which this catalog entry is expected to be active.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getLastUpdated
public DateTime getLastUpdated()
Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getAdditionalCharacteristic
public java.util.List<CodeableConcept> getAdditionalCharacteristic()
Used for examplefor Out of Formulary, or any specifics.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getAdditionalClassification
public java.util.List<CodeableConcept> getAdditionalClassification()
User for example for ATC classification, or.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getRelatedEntry
public java.util.List<CatalogEntry.RelatedEntry> getRelatedEntry()
Used for example, to point to a substance, or to a device used to administer a medication.- Returns:
- An unmodifiable list containing immutable objects of type
CatalogEntry.RelatedEntry
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public CatalogEntry.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static CatalogEntry.Builder builder()
-
-