Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.CatalogEntry

class HS.FHIR.DTL.vR4.Model.Resource.CatalogEntry extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

An entry in a catalog.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = CatalogEntry;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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 additionalCharacteristic as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "additionalCharacteristic", XMLPROJECTION = "ELEMENT");
CodeableConcept

Additional characteristics of the catalog entry.

any FHIR4 code from any ValueSet may be used.

Property methods: additionalCharacteristicBuildValueArray(), additionalCharacteristicCollectionToDisplay(), additionalCharacteristicCollectionToOdbc(), additionalCharacteristicDisplayToCollection(), additionalCharacteristicGet(), additionalCharacteristicGetObject(), additionalCharacteristicGetObjectId(), additionalCharacteristicGetSwizzled(), additionalCharacteristicIsValid(), additionalCharacteristicOdbcToCollection(), additionalCharacteristicSet(), additionalCharacteristicSetObject(), additionalCharacteristicSetObjectId()
property additionalClassification as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "additionalClassification", XMLPROJECTION = "ELEMENT");
CodeableConcept

Additional classification of the catalog entry.

any FHIR4 code from any ValueSet may be used.

Property methods: additionalClassificationBuildValueArray(), additionalClassificationCollectionToDisplay(), additionalClassificationCollectionToOdbc(), additionalClassificationDisplayToCollection(), additionalClassificationGet(), additionalClassificationGetObject(), additionalClassificationGetObjectId(), additionalClassificationGetSwizzled(), additionalClassificationIsValid(), additionalClassificationOdbcToCollection(), additionalClassificationSet(), additionalClassificationSetObject(), additionalClassificationSetObjectId()
property additionalIdentifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "additionalIdentifier", XMLPROJECTION = "ELEMENT");
Identifier

Any additional identifier(s) for the catalog item, in the same granularity or concept.

Property methods: additionalIdentifierBuildValueArray(), additionalIdentifierCollectionToDisplay(), additionalIdentifierCollectionToOdbc(), additionalIdentifierDisplayToCollection(), additionalIdentifierGet(), additionalIdentifierGetObject(), additionalIdentifierGetObjectId(), additionalIdentifierGetSwizzled(), additionalIdentifierIsValid(), additionalIdentifierOdbcToCollection(), additionalIdentifierSet(), additionalIdentifierSetObject(), additionalIdentifierSetObjectId()
property classification as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "classification", XMLPROJECTION = "ELEMENT");
CodeableConcept

Classification (category or class) of the item entry.

any FHIR4 code from any ValueSet may be used.

Property methods: classificationBuildValueArray(), classificationCollectionToDisplay(), classificationCollectionToOdbc(), classificationDisplayToCollection(), classificationGet(), classificationGetObject(), classificationGetObjectId(), classificationGetSwizzled(), classificationIsValid(), classificationOdbcToCollection(), classificationSet(), classificationSetObject(), classificationSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Unique identifier of the catalog item.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property lastUpdated as %String (MAXLEN = 1000000, XMLNAME = "lastUpdated", XMLPROJECTION = "ATTRIBUTE");
dateTime

When was this catalog last updated.

Property methods: lastUpdatedDisplayToLogical(), lastUpdatedGet(), lastUpdatedIsValid(), lastUpdatedLogicalToDisplay(), lastUpdatedLogicalToOdbc(), lastUpdatedNormalize(), lastUpdatedSet()
property orderable as %Boolean (XMLNAME = "orderable", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Whether the entry represents an orderable item.

Property methods: orderableDisplayToLogical(), orderableGet(), orderableIsValid(), orderableLogicalToDisplay(), orderableLogicalToXSD(), orderableNormalize(), orderableSet(), orderableXSDToLogical()
property referencedItem as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "referencedItem", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

The item that is being defined.

Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary

Property methods: referencedItemGet(), referencedItemGetSwizzled(), referencedItemIsValid(), referencedItemNewObject(), referencedItemSet()
property relatedEntry as list of HS.FHIR.DTL.vR4.Model.Element.CatalogEntry.relatedEntry (XMLNAME = "relatedEntry", XMLPROJECTION = "ELEMENT");
BackboneElement

An item that this catalog entry is related to.

Property methods: relatedEntryBuildValueArray(), relatedEntryCollectionToDisplay(), relatedEntryCollectionToOdbc(), relatedEntryDisplayToCollection(), relatedEntryGet(), relatedEntryGetObject(), relatedEntryGetObjectId(), relatedEntryGetSwizzled(), relatedEntryIsValid(), relatedEntryOdbcToCollection(), relatedEntrySet(), relatedEntrySetObject(), relatedEntrySetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

draft | active | retired | unknown

publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend publication-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

The type of item - medication, device, service, protocol or other.

any FHIR4 code from any ValueSet may be used.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property validTo as %String (MAXLEN = 1000000, XMLNAME = "validTo", XMLPROJECTION = "ATTRIBUTE");
dateTime

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.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "validityPeriod", XMLPROJECTION = "ELEMENT");
Period

The time period in which this catalog entry is expected to be active.

Property methods: validityPeriodGet(), validityPeriodGetSwizzled(), validityPeriodIsValid(), validityPeriodNewObject(), validityPeriodSet()

Inherited Members

Inherited Properties

Inherited Methods