## On this page Catalog entries are wrappers that contextualize items included in a catalog. - Schema - Usage - Relationships ## Elements | Name | Required | Type | Description | |----------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | identifier | | [Identifier](/content/docs/api/fhir/datatypes/identifier/index.html)[] | Unique identifier of the catalog item
Details
Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. | | type | | [CodeableConcept](/content/docs/api/fhir/datatypes/codeableconcept/index.html) | The type of item - medication, device, service, protocol or other
Details
The type of item - medication, device, service, protocol or other. | | orderable | ✓ | boolean | Whether the entry represents an orderable item
Details
Whether the entry represents an orderable item. | | referencedItem | ✓ | Reference< [Medication](/content/docs/api/fhir/resources/medication/index.html)
\\| [Device](/content/docs/api/fhir/resources/device/index.html)
\\| [Organization](/content/docs/api/fhir/resources/organization/index.html)
\\| [Practitioner](/content/docs/api/fhir/resources/practitioner/index.html)
\\| [PractitionerRole](/content/docs/api/fhir/resources/practitionerrole/index.html)
\\| [HealthcareService](/content/docs/api/fhir/resources/healthcareservice/index.html)
\\| [ActivityDefinition](/content/docs/api/fhir/resources/activitydefinition/index.html)
\\| [PlanDefinition](/content/docs/api/fhir/resources/plandefinition/index.html)
\\| [SpecimenDefinition](/content/docs/api/fhir/resources/specimendefinition/index.html)
\\| [ObservationDefinition](/content/docs/api/fhir/resources/observationdefinition/index.html)
\\| [Binary](/content/docs/api/fhir/resources/binary/index.html) > | The item that is being defined
Details
The item in a catalog or definition. | | additionalIdentifier | | [Identifier](/content/docs/api/fhir/datatypes/identifier/index.html)[] | Any additional identifier(s) for the catalog item, in the same granularity or concept
Details
Used in supporting related concepts, e.g. NDC to RxNorm. | | classification | | [CodeableConcept](/content/docs/api/fhir/datatypes/codeableconcept/index.html)[] | Classification (category or class) of the item entry
Details
Classes of devices, or ATC for medication. | | status | | code | draft \\| active \\| retired \\| unknown
Details
Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable. | | validityPeriod | | [Period](/content/docs/api/fhir/datatypes/period/index.html) | The time period in which this catalog entry is expected to be active
Details
The time period in which this catalog entry is expected to be active. | | validTo | | dateTime | The date until which this catalog entry is expected to be active
Details
The date until which this catalog entry is expected to be active. | | lastUpdated | | dateTime | When was this catalog last updated
Details
Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
Perhaps not needed - if we use fhir resource metadata. | | additionalCharacteristic | | [CodeableConcept](/content/docs/api/fhir/datatypes/codeableconcept/index.html)[] | Additional characteristics of the catalog entry
Details
Used for example for Out of Formulary, or any specifics. | | additionalClassification | | [CodeableConcept](/content/docs/api/fhir/datatypes/codeableconcept/index.html)[] | Additional classification of the catalog entry
Details
User for example for ATC classification, or. | | relatedEntry | | CatalogEntryRelatedEntry[] | An item that this catalog entry is related to
Details
Used for example, to point to a substance, or to a device used to administer a medication. | | id | | string | Unique id for inter-element referencing
Details
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | | extension | | [Extension](/content/docs/api/fhir/datatypes/extension/index.html)[] | Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the element. | | modifierExtension | | [Extension](/content/docs/api/fhir/datatypes/extension/index.html)[] | Extensions that cannot be ignored even if unrecognized
Details
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | | relationtype | ✓ | code | triggers \\| is-replaced-by
Details
The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc. | | item | ✓ | Reference< [CatalogEntry](/content/docs/api/fhir/resources/catalogentry/index.html) > | The reference to the related item
Details
The reference to the related item. | ## Search Parameters _None_ ## Inherited Elements The [CatalogEntry](/content/docs/api/fhir/resources/catalogentry/index.html) resource (formally known as EntryDefinition) allows additional information specification for items that may be found in the following types of clinical collections, including but not limited to: - A pharmacy formulary - A laboratory compendium - A radiology compendium of exams that may be ordered - A dietary nutrition order catalog - A supply charge master - A CDS catalog of knowledge artifacts The Catalog profile of the [Composition](/content/docs/api/fhir/resources/composition/index.html) resource is used to organize catalog entries. Catalogs are composed of nestable sections which contain catalog entries. Catalog entries wrap the items that are orderable or selectable in a catalog and any other required supporting entries. Examples of information provided by [CatalogEntry](/content/docs/api/fhir/resources/catalogentry/index.html) includes whether the status of the item in the catalog is "active", "inactive", "legacy", or "informative" or whether the item is an orderable item in the context of this catalog (or catalog section). the relation between the item and other items ("contains", "includes", "requires"). Catalog entries also support relationships to other catalog entries such as whether a product is now replaced by another product in a product catalog. Please refer to the Boundaries and Relationships part of this document for more information on the topic. This [CatalogEntry](/content/docs/api/fhir/resources/catalogentry/index.html) resource wraps and contextualizes definitional items that make up a catalog such as the following resources: - [Medication](/content/docs/api/fhir/resources/medication/index.html) - [Device](/content/docs/api/fhir/resources/device/index.html) - [Activity Definition (including laboratory service definitions)](/content/docs/api/fhir/resources/activitydefinition/index.html) - [Specimen Definition](/content/docs/api/fhir/resources/specimendefinition/index.html)