HS.FHIRModel.R4.CatalogEntry
class HS.FHIRModel.R4.CatalogEntry extends HS.FHIRModel.FHIRClassSuper
******************************************* CatalogEntry generated class schema
*****************************************
Catalog entries are wrappers that contextualize items included in a catalog.
Property Inventory
- _implicitRules
- _language
- _lastUpdated
- _orderable
- _status
- _validTo
- additionalCharacteristic
- additionalClassification
- additionalIdentifier
- classification
- contained
- extension
- fhirID
- identifier
- implicitRules
- language
- lastUpdated
- meta
- modifierExtension
- orderable
- referencedItem
- relatedEntry
- resourceType
- status
- text
- type
- validTo
- validityPeriod
Method Inventory
- IncludeAdditionalCharacteristic()
- IncludeAdditionalClassification()
- IncludeAdditionalIdentifier()
- IncludeClassification()
- IncludeContained()
- IncludeExtension()
- IncludeIdentifier()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeReferencedItem()
- IncludeRelatedEntry()
- IncludeText()
- IncludeType()
- IncludeValidityPeriod()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_CATALOGENTRY;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _lastUpdated as HS.FHIRModel.R4.Element;
Extensions for lastUpdated
Property methods: _lastUpdatedGet(), _lastUpdatedGetSwizzled(), _lastUpdatedIsValid(), _lastUpdatedNewObject(), _lastUpdatedSet()
property _orderable as HS.FHIRModel.R4.Element;
Extensions for orderable
Property methods: _orderableGet(), _orderableGetSwizzled(), _orderableIsValid(), _orderableNewObject(), _orderableSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _validTo as HS.FHIRModel.R4.Element;
Extensions for validTo
Property methods: _validToGet(), _validToGetSwizzled(), _validToIsValid(), _validToNewObject(), _validToSet()
property additionalCharacteristic as HS.FHIRModel.R4.SeqOfCodeableConcept;
Used for examplefor Out of Formulary, or any specifics.
Property methods: additionalCharacteristicGet(), additionalCharacteristicGetSwizzled(), additionalCharacteristicIsValid(), additionalCharacteristicNewObject(), additionalCharacteristicSet()
property additionalClassification as HS.FHIRModel.R4.SeqOfCodeableConcept;
User for example for ATC classification, or.
Property methods: additionalClassificationGet(), additionalClassificationGetSwizzled(), additionalClassificationIsValid(), additionalClassificationNewObject(), additionalClassificationSet()
property additionalIdentifier as HS.FHIRModel.R4.SeqOfIdentifier;
Used in supporting related concepts, e.g. NDC to RxNorm.
Property methods: additionalIdentifierGet(), additionalIdentifierGetSwizzled(), additionalIdentifierIsValid(), additionalIdentifierNewObject(), additionalIdentifierSet()
property classification as HS.FHIRModel.R4.SeqOfCodeableConcept;
Classes of devices, or ATC for medication.
Property methods: classificationGet(), classificationGetSwizzled(), classificationIsValid(), classificationNewObject(), classificationSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Used in supporting different identifiers for the same product, e.g.
manufacturer code and retailer code.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property lastUpdated as %String;
Typically date of issue is different from the beginning of the validity.
This can be used to see when an item was last updated.
Property methods: lastUpdatedDisplayToLogical(), lastUpdatedGet(), lastUpdatedIsValid(), lastUpdatedLogicalToDisplay(), lastUpdatedLogicalToOdbc(), lastUpdatedNormalize(), lastUpdatedSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property orderable as %Boolean;
Whether the entry represents an orderable item.
Property methods: orderableDisplayToLogical(), orderableGet(), orderableIsValid(), orderableLogicalToDisplay(), orderableLogicalToXSD(), orderableNormalize(), orderableSet(), orderableXSDToLogical()
property referencedItem as HS.FHIRModel.R4.Reference [ Required ];
The item in a catalog or definition.
Property methods: referencedItemGet(), referencedItemGetSwizzled(), referencedItemIsValid(), referencedItemNewObject(), referencedItemSet()
Used for example, to point to a substance, or to a device used to
administer a medication.
Property methods: relatedEntryGet(), relatedEntryGetSwizzled(), relatedEntryIsValid(), relatedEntryNewObject(), relatedEntrySet()
property resourceType as %String [ InitialExpression = "CatalogEntry" , Required ];
This is a CatalogEntry resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
Used to support catalog exchange even for unsupported products, e.g.
getting list of medications even if not prescribable.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as HS.FHIRModel.R4.CodeableConcept;
The type of item - medication, device, service, protocol or other.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property validTo as %String;
The date until which this catalog entry is expected to be active.
Property methods: validToDisplayToLogical(), validToGet(), validToIsValid(), validToLogicalToDisplay(), validToLogicalToOdbc(), validToNormalize(), validToSet()
property validityPeriod as HS.FHIRModel.R4.Period;
The time period in which this catalog entry is expected to be active.
Property methods: validityPeriodGet(), validityPeriodGetSwizzled(), validityPeriodIsValid(), validityPeriodNewObject(), validityPeriodSet()
Methods
method IncludeAdditionalCharacteristic()
method IncludeAdditionalClassification()
method IncludeAdditionalIdentifier()
method IncludeClassification()
method IncludeContained()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeReferencedItem()
method IncludeRelatedEntry()
method IncludeText()
method IncludeType()
method IncludeValidityPeriod()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.CatalogEntry
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()