Skip to main content

CatalogEntry

Catalog entries are wrappers that contextualize items included in a catalog. If the element is present, it must have either a @value, an @id, or extensions

type CatalogEntry implements Resource {
  identifier: [Identifier]
  type: CodeableConcept
  orderable: Boolean
  referencedItem: Reference
  additionalIdentifier: [Identifier]
  classification: [CodeableConcept]
  status: String
  validityPeriod: Period
  validTo: Date
  lastUpdated: Date
  additionalCharacteristic: [CodeableConcept]
  additionalClassification: [CodeableConcept]
  relatedEntry: [CatalogEntryRelatedEntry]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

CatalogEntry.identifier ● [Identifier] list object​

Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.

CatalogEntry.type ● CodeableConcept object​

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

CatalogEntry.orderable ● Boolean scalar​

Whether the entry represents an orderable item.

CatalogEntry.referencedItem ● Reference object​

The item in a catalog or definition.

CatalogEntry.additionalIdentifier ● [Identifier] list object​

Used in supporting related concepts, e.g. NDC to RxNorm.

CatalogEntry.classification ● [CodeableConcept] list object​

Classes of devices, or ATC for medication.

CatalogEntry.status ● String scalar​

Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

CatalogEntry.validityPeriod ● Period object​

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

CatalogEntry.validTo ● Date scalar​

The date until which this catalog entry is expected to be active.

CatalogEntry.lastUpdated ● Date scalar​

Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

CatalogEntry.additionalCharacteristic ● [CodeableConcept] list object​

Used for examplefor Out of Formulary, or any specifics.

CatalogEntry.additionalClassification ● [CodeableConcept] list object​

User for example for ATC classification, or.

CatalogEntry.relatedEntry ● [CatalogEntryRelatedEntry] list object​

Used for example, to point to a substance, or to a device used to administer a medication.

CatalogEntry.text ● Narrative object​

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.

CatalogEntry.contained ● [Resource] list interface​

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.

CatalogEntry.extension ● [Extension] list object​

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.

CatalogEntry.modifierExtension ● [Extension] list object​

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

CatalogEntry.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

CatalogEntry.meta ● Meta object​

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.

CatalogEntry.implicitRules ● Uri scalar​

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.

CatalogEntry.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

CatalogEntry query ● CatalogEntryCreate mutation ● CatalogEntryList query ● CatalogEntryUpdate mutation