Package com.ibm.fhir.model.resource

Class CatalogEntry

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class CatalogEntry
extends DomainResource
    Catalog entries are wrappers that contextualize items included in a catalog.

    Maturity level: FMM0 (Trial Use)

    • Method Detail

      • getIdentifier

        public 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 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 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 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 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 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.

      • accept

        public void accept​(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 interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object