CatalogEntry - FHIR v4.3.0

Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). This is a downloaded version of the specification. For a full list of available versions, see the Directory of published versions

8.28.6 Resource CatalogEntry - Detailed Descriptions

Orders and Observations

Work Group

Maturity Level: 0

Trial Use

Security Category: Business

Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the CatalogEntry resource.

CatalogEntry
Element Id	CatalogEntry
Definition	Catalog entries are wrappers that contextualize items included in a catalog.
Cardinality	0..*
Type	DomainResource
Summary	false
CatalogEntry.identifier
Element Id	CatalogEntry.identifier
Definition	Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
Note	This is a business identifier, not a resource identifier (see discussion)
Cardinality	0..*
Type	Identifier
Summary	true
CatalogEntry.type
Element Id	CatalogEntry.type
Definition	The type of item - medication, device, service, protocol or other.
Cardinality	0..1
Type	CodeableConcept
Summary	false
CatalogEntry.orderable
Element Id	CatalogEntry.orderable
Definition	Whether the entry represents an orderable item.
Cardinality	1..1
Type	boolean
Summary	true
CatalogEntry.referencedItem
Element Id	CatalogEntry.referencedItem
Definition	The item in a catalog or definition.
Cardinality	1..1
Type	Reference(Medication \| Device \| Organization \| Practitioner \| PractitionerRole \| HealthcareService \| ActivityDefinition \| PlanDefinition \| SpecimenDefinition \| ObservationDefinition \| Binary)
Summary	true
CatalogEntry.additionalIdentifier
Element Id	CatalogEntry.additionalIdentifier
Definition	Used in supporting related concepts, e.g. NDC to RxNorm.
Cardinality	0..*
Type	Identifier
Summary	false
CatalogEntry.classification
Element Id	CatalogEntry.classification
Definition	Classes of devices, or ATC for medication.
Cardinality	0..*
Type	CodeableConcept
Summary	false
CatalogEntry.status
Element Id	CatalogEntry.status
Definition	Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
Cardinality	0..1
Terminology Binding	PublicationStatus (Required)
Type	code
Summary	false
CatalogEntry.validityPeriod
Element Id	CatalogEntry.validityPeriod
Definition	The time period in which this catalog entry is expected to be active.
Cardinality	0..1
Type	Period
Summary	false
CatalogEntry.validTo
Element Id	CatalogEntry.validTo
Definition	The date until which this catalog entry is expected to be active.
Cardinality	0..1
Type	dateTime
Summary	false
CatalogEntry.lastUpdated
Element Id	CatalogEntry.lastUpdated
Definition	Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
Cardinality	0..1
Type	dateTime
Summary	false
Comments	Perhaps not needed - if we use fhir resource metadata.
CatalogEntry.additionalCharacteristic
Element Id	CatalogEntry.additionalCharacteristic
Definition	Used for examplefor Out of Formulary, or any specifics.
Cardinality	0..*
Type	CodeableConcept
Summary	false
CatalogEntry.additionalClassification
Element Id	CatalogEntry.additionalClassification
Definition	User for example for ATC classification, or.
Cardinality	0..*
Type	CodeableConcept
Summary	false
CatalogEntry.relatedEntry
Element Id	CatalogEntry.relatedEntry
Definition	Used for example, to point to a substance, or to a device used to administer a medication.
Cardinality	0..*
Summary	false
CatalogEntry.relatedEntry.relationtype
Element Id	CatalogEntry.relatedEntry.relationtype
Definition	The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.
Cardinality	1..1
Terminology Binding	CatalogEntryRelationType (Required)
Type	code
Summary	false
CatalogEntry.relatedEntry.item
Element Id	CatalogEntry.relatedEntry.item
Definition	The reference to the related item.
Cardinality	1..1
Type	Reference(CatalogEntry)
Summary	false