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
Catalog entries are wrappers that contextualize items included in a catalog.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<CodeableConcept> Used for examplefor Out of Formulary, or any specifics.protected List
<CodeableConcept> User for example for ATC classification, or.protected List
<Identifier> Used in supporting related concepts, e.g.protected List
<CodeableConcept> Classes of devices, or ATC for medication.protected List
<Identifier> Used in supporting different identifiers for the same product, e.g.protected DateTimeType
Typically date of issue is different from the beginning of the validity.protected BooleanType
Whether the entry represents an orderable item.protected Reference
The item in a catalog or definition.protected Resource
The actual object that is the target of the reference (The item in a catalog or definition.)Used for example, to point to a substance, or to a device used to administer a medication.protected Enumeration
<Enumerations.PublicationStatus> Used to support catalog exchange even for unsupported products, e.g.protected CodeableConcept
The type of item - medication, device, service, protocol or other.protected Period
The time period in which this catalog entry is expected to be active.protected DateTimeType
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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorCatalogEntry
(BooleanType orderable, Reference referencedItem) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
copyValues
(CatalogEntry dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) boolean
Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAdditionalCharacteristic
(List<CodeableConcept> theAdditionalCharacteristic) setAdditionalClassification
(List<CodeableConcept> theAdditionalClassification) setAdditionalIdentifier
(List<Identifier> theAdditionalIdentifier) setClassification
(List<CodeableConcept> theClassification) setIdentifier
(List<Identifier> theIdentifier) setLastUpdated
(Date value) setOrderable
(boolean value) setOrderableElement
(BooleanType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReferencedItem
(Reference value) setReferencedItemTarget
(Resource value) setRelatedEntry
(List<CatalogEntry.CatalogEntryRelatedEntryComponent> theRelatedEntry) setType
(CodeableConcept value) setValidityPeriod
(Period value) setValidTo
(Date value) setValidToElement
(DateTimeType value) protected CatalogEntry
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. -
type
The type of item - medication, device, service, protocol or other. -
orderable
Whether the entry represents an orderable item. -
referencedItem
The item in a catalog or definition. -
referencedItemTarget
The actual object that is the target of the reference (The item in a catalog or definition.) -
additionalIdentifier
Used in supporting related concepts, e.g. NDC to RxNorm. -
classification
Classes of devices, or ATC for medication. -
status
Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable. -
validityPeriod
The time period in which this catalog entry is expected to be active. -
validTo
The date until which this catalog entry is expected to be active. -
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
Used for examplefor Out of Formulary, or any specifics. -
additionalClassification
User for example for ATC classification, or.
-
-
Constructor Details
-
CatalogEntry
public CatalogEntry()Constructor -
CatalogEntry
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getType
- Returns:
type
(The type of item - medication, device, service, protocol or other.)
-
hasType
-
setType
- Parameters:
value
-type
(The type of item - medication, device, service, protocol or other.)
-
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
-
hasOrderable
-
setOrderableElement
- 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
- Returns:
- Whether the entry represents an orderable item.
-
setOrderable
- Parameters:
value
- Whether the entry represents an orderable item.
-
getReferencedItem
- Returns:
referencedItem
(The item in a catalog or definition.)
-
hasReferencedItem
-
setReferencedItem
- Parameters:
value
-referencedItem
(The item in a catalog or definition.)
-
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
- 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
- Returns:
additionalIdentifier
(Used in supporting related concepts, e.g. NDC to RxNorm.)
-
setAdditionalIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalIdentifier
-
addAdditionalIdentifier
-
addAdditionalIdentifier
-
getAdditionalIdentifierFirstRep
- Returns:
- The first repetition of repeating field
additionalIdentifier
, creating it if it does not already exist
-
getClassification
- Returns:
classification
(Classes of devices, or ATC for medication.)
-
setClassification
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClassification
-
addClassification
-
addClassification
-
getClassificationFirstRep
- Returns:
- The first repetition of repeating field
classification
, creating it if it does not already exist
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
-
setStatus
- Parameters:
value
- Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
-
getValidityPeriod
- Returns:
validityPeriod
(The time period in which this catalog entry is expected to be active.)
-
hasValidityPeriod
-
setValidityPeriod
- Parameters:
value
-validityPeriod
(The time period in which this catalog entry is expected to be active.)
-
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
-
hasValidTo
-
setValidToElement
- 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
- Returns:
- The date until which this catalog entry is expected to be active.
-
setValidTo
- Parameters:
value
- The date until which this catalog entry is expected to be active.
-
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
-
hasLastUpdated
-
setLastUpdatedElement
- 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
- 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
- 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
- Returns:
additionalCharacteristic
(Used for examplefor Out of Formulary, or any specifics.)
-
setAdditionalCharacteristic
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalCharacteristic
-
addAdditionalCharacteristic
-
addAdditionalCharacteristic
-
getAdditionalCharacteristicFirstRep
- Returns:
- The first repetition of repeating field
additionalCharacteristic
, creating it if it does not already exist
-
getAdditionalClassification
- Returns:
additionalClassification
(User for example for ATC classification, or.)
-
setAdditionalClassification
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalClassification
-
addAdditionalClassification
-
addAdditionalClassification
-
getAdditionalClassificationFirstRep
- Returns:
- The first repetition of repeating field
additionalClassification
, creating it if it does not already exist
-
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
-
addRelatedEntry
-
addRelatedEntry
-
getRelatedEntryFirstRep
- Returns:
- The first repetition of repeating field
relatedEntry
, creating it if it does not already exist
-
listChildren
- 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
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-