Package org.hl7.fhir.r4.model
Class CatalogEntry
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.CatalogEntry
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
public class CatalogEntry extends DomainResource
Catalog entries are wrappers that contextualize items included in a catalog.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CatalogEntry.CatalogEntryRelatedEntryComponent
static class
CatalogEntry.CatalogEntryRelationType
static class
CatalogEntry.CatalogEntryRelationTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<CodeableConcept>
additionalCharacteristic
Used for examplefor Out of Formulary, or any specifics.protected List<CodeableConcept>
additionalClassification
User for example for ATC classification, or.protected List<Identifier>
additionalIdentifier
Used in supporting related concepts, e.g.protected List<CodeableConcept>
classification
Classes of devices, or ATC for medication.protected List<Identifier>
identifier
Used in supporting different identifiers for the same product, e.g.protected DateTimeType
lastUpdated
Typically date of issue is different from the beginning of the validity.protected BooleanType
orderable
Whether the entry represents an orderable item.protected Reference
referencedItem
The item in a catalog or definition.protected Resource
referencedItemTarget
The actual object that is the target of the reference (The item in a catalog or definition.)protected List<CatalogEntry.CatalogEntryRelatedEntryComponent>
relatedEntry
Used for example, to point to a substance, or to a device used to administer a medication.protected Enumeration<Enumerations.PublicationStatus>
status
Used to support catalog exchange even for unsupported products, e.g.protected CodeableConcept
type
The type of item - medication, device, service, protocol or other.protected Period
validityPeriod
The time period in which this catalog entry is expected to be active.protected DateTimeType
validTo
The date until which this catalog entry is expected to be active.-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description CatalogEntry()
ConstructorCatalogEntry(BooleanType orderable, Reference referencedItem)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, 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.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
-
type
protected CodeableConcept type
The type of item - medication, device, service, protocol or other.
-
orderable
protected BooleanType orderable
Whether the entry represents an orderable item.
-
referencedItem
protected Reference referencedItem
The item in a catalog or definition.
-
referencedItemTarget
protected Resource referencedItemTarget
The actual object that is the target of the reference (The item in a catalog or definition.)
-
additionalIdentifier
protected List<Identifier> additionalIdentifier
Used in supporting related concepts, e.g. NDC to RxNorm.
-
classification
protected List<CodeableConcept> classification
Classes of devices, or ATC for medication.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
-
validityPeriod
protected Period validityPeriod
The time period in which this catalog entry is expected to be active.
-
validTo
protected DateTimeType validTo
The date until which this catalog entry is expected to be active.
-
lastUpdated
protected DateTimeType lastUpdated
Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
-
additionalCharacteristic
protected List<CodeableConcept> additionalCharacteristic
Used for examplefor Out of Formulary, or any specifics.
-
additionalClassification
protected List<CodeableConcept> additionalClassification
User for example for ATC classification, or.
-
relatedEntry
protected List<CatalogEntry.CatalogEntryRelatedEntryComponent> relatedEntry
Used for example, to point to a substance, or to a device used to administer a medication.
-
-
Constructor Detail
-
CatalogEntry
public CatalogEntry()
Constructor
-
CatalogEntry
public CatalogEntry(BooleanType orderable, Reference referencedItem)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier
(Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.)
-
setIdentifier
public CatalogEntry setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public CatalogEntry addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getType
public CodeableConcept getType()
- Returns:
type
(The type of item - medication, device, service, protocol or other.)
-
hasType
public boolean hasType()
-
setType
public CatalogEntry setType(CodeableConcept value)
- Parameters:
value
-type
(The type of item - medication, device, service, protocol or other.)
-
getOrderableElement
public BooleanType getOrderableElement()
- Returns:
orderable
(Whether the entry represents an orderable item.). This is the underlying object with id, value and extensions. The accessor "getOrderable" gives direct access to the value
-
hasOrderableElement
public boolean hasOrderableElement()
-
hasOrderable
public boolean hasOrderable()
-
setOrderableElement
public CatalogEntry setOrderableElement(BooleanType value)
- Parameters:
value
-orderable
(Whether the entry represents an orderable item.). This is the underlying object with id, value and extensions. The accessor "getOrderable" gives direct access to the value
-
getOrderable
public boolean getOrderable()
- Returns:
- Whether the entry represents an orderable item.
-
setOrderable
public CatalogEntry setOrderable(boolean value)
- Parameters:
value
- Whether the entry represents an orderable item.
-
getReferencedItem
public Reference getReferencedItem()
- Returns:
referencedItem
(The item in a catalog or definition.)
-
hasReferencedItem
public boolean hasReferencedItem()
-
setReferencedItem
public CatalogEntry setReferencedItem(Reference value)
- Parameters:
value
-referencedItem
(The item in a catalog or definition.)
-
getReferencedItemTarget
public Resource getReferencedItemTarget()
- Returns:
referencedItem
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. (The item in a catalog or definition.)
-
setReferencedItemTarget
public CatalogEntry setReferencedItemTarget(Resource value)
- Parameters:
value
-referencedItem
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. (The item in a catalog or definition.)
-
getAdditionalIdentifier
public List<Identifier> getAdditionalIdentifier()
- Returns:
additionalIdentifier
(Used in supporting related concepts, e.g. NDC to RxNorm.)
-
setAdditionalIdentifier
public CatalogEntry setAdditionalIdentifier(List<Identifier> theAdditionalIdentifier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalIdentifier
public boolean hasAdditionalIdentifier()
-
addAdditionalIdentifier
public Identifier addAdditionalIdentifier()
-
addAdditionalIdentifier
public CatalogEntry addAdditionalIdentifier(Identifier t)
-
getAdditionalIdentifierFirstRep
public Identifier getAdditionalIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
additionalIdentifier
, creating it if it does not already exist
-
getClassification
public List<CodeableConcept> getClassification()
- Returns:
classification
(Classes of devices, or ATC for medication.)
-
setClassification
public CatalogEntry setClassification(List<CodeableConcept> theClassification)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClassification
public boolean hasClassification()
-
addClassification
public CodeableConcept addClassification()
-
addClassification
public CatalogEntry addClassification(CodeableConcept t)
-
getClassificationFirstRep
public CodeableConcept getClassificationFirstRep()
- Returns:
- The first repetition of repeating field
classification
, creating it if it does not already exist
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Returns:
status
(Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public CatalogEntry setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Parameters:
value
-status
(Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Returns:
- Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
-
setStatus
public CatalogEntry setStatus(Enumerations.PublicationStatus value)
- Parameters:
value
- Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
-
getValidityPeriod
public Period getValidityPeriod()
- Returns:
validityPeriod
(The time period in which this catalog entry is expected to be active.)
-
hasValidityPeriod
public boolean hasValidityPeriod()
-
setValidityPeriod
public CatalogEntry setValidityPeriod(Period value)
- Parameters:
value
-validityPeriod
(The time period in which this catalog entry is expected to be active.)
-
getValidToElement
public DateTimeType getValidToElement()
- Returns:
validTo
(The date until which this catalog entry is expected to be active.). This is the underlying object with id, value and extensions. The accessor "getValidTo" gives direct access to the value
-
hasValidToElement
public boolean hasValidToElement()
-
hasValidTo
public boolean hasValidTo()
-
setValidToElement
public CatalogEntry setValidToElement(DateTimeType value)
- Parameters:
value
-validTo
(The date until which this catalog entry is expected to be active.). This is the underlying object with id, value and extensions. The accessor "getValidTo" gives direct access to the value
-
getValidTo
public Date getValidTo()
- Returns:
- The date until which this catalog entry is expected to be active.
-
setValidTo
public CatalogEntry setValidTo(Date value)
- Parameters:
value
- The date until which this catalog entry is expected to be active.
-
getLastUpdatedElement
public DateTimeType getLastUpdatedElement()
- Returns:
lastUpdated
(Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.). This is the underlying object with id, value and extensions. The accessor "getLastUpdated" gives direct access to the value
-
hasLastUpdatedElement
public boolean hasLastUpdatedElement()
-
hasLastUpdated
public boolean hasLastUpdated()
-
setLastUpdatedElement
public CatalogEntry setLastUpdatedElement(DateTimeType value)
- Parameters:
value
-lastUpdated
(Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.). This is the underlying object with id, value and extensions. The accessor "getLastUpdated" gives direct access to the value
-
getLastUpdated
public Date getLastUpdated()
- Returns:
- Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
-
setLastUpdated
public CatalogEntry setLastUpdated(Date value)
- Parameters:
value
- Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
-
getAdditionalCharacteristic
public List<CodeableConcept> getAdditionalCharacteristic()
- Returns:
additionalCharacteristic
(Used for examplefor Out of Formulary, or any specifics.)
-
setAdditionalCharacteristic
public CatalogEntry setAdditionalCharacteristic(List<CodeableConcept> theAdditionalCharacteristic)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalCharacteristic
public boolean hasAdditionalCharacteristic()
-
addAdditionalCharacteristic
public CodeableConcept addAdditionalCharacteristic()
-
addAdditionalCharacteristic
public CatalogEntry addAdditionalCharacteristic(CodeableConcept t)
-
getAdditionalCharacteristicFirstRep
public CodeableConcept getAdditionalCharacteristicFirstRep()
- Returns:
- The first repetition of repeating field
additionalCharacteristic
, creating it if it does not already exist
-
getAdditionalClassification
public List<CodeableConcept> getAdditionalClassification()
- Returns:
additionalClassification
(User for example for ATC classification, or.)
-
setAdditionalClassification
public CatalogEntry setAdditionalClassification(List<CodeableConcept> theAdditionalClassification)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalClassification
public boolean hasAdditionalClassification()
-
addAdditionalClassification
public CodeableConcept addAdditionalClassification()
-
addAdditionalClassification
public CatalogEntry addAdditionalClassification(CodeableConcept t)
-
getAdditionalClassificationFirstRep
public CodeableConcept getAdditionalClassificationFirstRep()
- Returns:
- The first repetition of repeating field
additionalClassification
, creating it if it does not already exist
-
getRelatedEntry
public List<CatalogEntry.CatalogEntryRelatedEntryComponent> getRelatedEntry()
- Returns:
relatedEntry
(Used for example, to point to a substance, or to a device used to administer a medication.)
-
setRelatedEntry
public CatalogEntry setRelatedEntry(List<CatalogEntry.CatalogEntryRelatedEntryComponent> theRelatedEntry)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedEntry
public boolean hasRelatedEntry()
-
addRelatedEntry
public CatalogEntry.CatalogEntryRelatedEntryComponent addRelatedEntry()
-
addRelatedEntry
public CatalogEntry addRelatedEntry(CatalogEntry.CatalogEntryRelatedEntryComponent t)
-
getRelatedEntryFirstRep
public CatalogEntry.CatalogEntryRelatedEntryComponent getRelatedEntryFirstRep()
- Returns:
- The first repetition of repeating field
relatedEntry
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public CatalogEntry copy()
- Specified by:
copy
in classDomainResource
-
copyValues
public void copyValues(CatalogEntry dst)
-
typedCopy
protected CatalogEntry typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-