Path | Short | Definition | Comments |
---|---|---|---|
An entry in a catalog | Catalog entries are wrappers that contextualize items included in a catalog. | ||
identifier | Unique identifier of the catalog item | 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 | The type of item - medication, device, service, protocol or other. | |
orderable | Whether the entry represents an orderable item | Whether the entry represents an orderable item. | |
referencedItem | The item that is being defined | The item in a catalog or definition. | |
additionalIdentifier | Any additional identifier(s) for the catalog item, in the same granularity or concept | Used in supporting related concepts, e.g. NDC to RxNorm. | |
classification | Classification (category or class) of the item entry | Classes of devices, or ATC for medication. | |
status | draft | active | retired | unknown | 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 | 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 | The date until which this catalog entry is expected to be active. | |
lastUpdated | When was this catalog last updated | 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 | Additional characteristics of the catalog entry | Used for examplefor Out of Formulary, or any specifics. | |
additionalClassification | Additional classification of the catalog entry | User for example for ATC classification, or. | |
relatedEntry | An item that this catalog entry is related to | Used for example, to point to a substance, or to a device used to administer a medication. | |
relatedEntry.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
relatedEntry.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. 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. | 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. |
relatedEntry.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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. |
relatedEntry.relationtype | triggers | is-replaced-by | The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc. | |
relatedEntry.item | The reference to the related item | The reference to the related item. |
The CatalogEntry 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:
The Catalog profile of the Composition 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 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.
It is important to note that CatalogEntry shall not specify attributes that are pertinent to the item that it wraps if those attributes hold true regardless of the catalog context. For instance, a catalog entry should generally not provide attributes to describe the hierarchical relationship of an item to other items (e.g., drug class or other such ontological relationships) since that information holds outside of the context of a catalog and thus should reside in the referenced item itself. A catalog entry may, however, specify a status of a given item in the context of the catalog such as whether that item is orderable a given institution or context. Catalog entries can also be related to one another. Here again, it is important to note that only relationships that hold within the context of a catalog and not generally for the item referenced by the catalog entry should be considered. For instance, in the context of a given laboratory service compendium, a laboratory order may be preferred over other laboratory orders. The other laboratory orders in this use case may thus be related to the preferred test using an 'is-replaced-by' relationship and assigned a new status of 'retired'. Other definitional relationships such as the specimen or expected input and output observation definitions associated with a particular laboratory test, relationships that generally hold outside of a laboratory catalog context, should reside at the level of the definitional resource itself. That is, laboratory tests often state the required input observation specifications, the format of the expected observation output, and the attributes of the required specimen and such relationships are probably best described outside of the CatalogEntry within the referenced item.