Release 4 5 Preview #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

8.28.5 8.28.7 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.

Type Identifier Type code Comments Perhaps not needed - if we use fhir resource metadata.
CatalogEntry
Element Id CatalogEntry
Definition

Catalog entries are wrappers that contextualize items included in a catalog.

Cardinality 0..*
Type DomainResource
CatalogEntry.identifier
Element Id CatalogEntry.identifier
Definition

Used in supporting different identifiers for Business identifier uniquely assigned to the same product, e.g. manufacturer code and retailer code. catalog entry.

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Summary true
CatalogEntry.name
Element Id CatalogEntry.name
Definition

The name of this catalog entry announces the item that is represented by the entry.

Cardinality 0..1
Type string
Summary true
CatalogEntry.type
Element Id CatalogEntry.type
Definition

The type of item - medication, device, service, protocol resource that is represented by this catalog entry.

Cardinality 0..1
Terminology Binding CatalogEntryType ( Required )
Type code
Summary true
CatalogEntry.status
Element Id CatalogEntry.status
Definition

Indicates whether this catalog entry is open to public usage (active) or other. not (draft or retired).

Cardinality 0..1
Terminology Binding CatalogEntryStatus ( Required )
Type CodeableConcept code
Is Modifier true (Reason: Not known why this is labelled a modifier)
Summary true
CatalogEntry.effectivePeriod
Element Id CatalogEntry.effectivePeriod
Definition

Period of usability of the catalog entry.

Cardinality 0..1
Type Period
CatalogEntry.orderable
Element Id CatalogEntry.orderable
Definition

Whether Indicates whether or not the entry represents an orderable item. item that is orderable.

Cardinality 1..1
Type boolean
Is Modifier true (Reason: Not known why this is labelled a modifier)
Summary true
CatalogEntry.referencedItem
Element Id CatalogEntry.referencedItem
Definition

The item in a (resource) that this entry of the catalog or definition. represents.

Cardinality 1..1
Type Reference ( Medication | Device DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary MedicationKnowledge | Substance | Location )
Patterns Reference(DeviceDefinition,Organization,Practitioner,PractitionerRole,HealthcareService,ActivityDefinition,PlanDefinition,SpecimenDefinition,ObservationDefinition,MedicationKnowledge,Substance,Location): No common pattern
Summary true
CatalogEntry.additionalIdentifier CatalogEntry.relatedEntry
Element Id CatalogEntry.additionalIdentifier CatalogEntry.relatedEntry
Definition

Used in supporting related concepts, e.g. NDC for example, to RxNorm. point to a substance, or to a device used to administer a medication.

Cardinality 0..*
CatalogEntry.classification CatalogEntry.relatedEntry.relationship
Element Id CatalogEntry.classification CatalogEntry.relatedEntry.relationship
Definition

Classes The type of devices, or ATC for medication. relationship to the related entry.

Cardinality 0..* 1..1
Terminology Binding CatalogEntryRelationType ( Required )
Type CodeableConcept code
CatalogEntry.status CatalogEntry.relatedEntry.target
Element Id CatalogEntry.status CatalogEntry.relatedEntry.target
Definition

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

Cardinality 0..1 1..1
Terminology Binding Type PublicationStatus Reference ( Required CatalogEntry )
CatalogEntry.validityPeriod CatalogEntry.updatedBy
Element Id CatalogEntry.validityPeriod CatalogEntry.updatedBy
Definition

The time period in which Last actor who recorded (created or updated) this catalog entry is expected to be active. entry.

Cardinality 0..1
Type Period Reference ( Person | Device )
Patterns Reference(Person,Device): No common pattern
CatalogEntry.validTo CatalogEntry.note
Element Id CatalogEntry.validTo CatalogEntry.note
Definition

The date until which Notes and comments about this catalog entry is expected to be active. entry.

Cardinality 0..1 0..*
Type dateTime Annotation
CatalogEntry.lastUpdated CatalogEntry.estimatedDuration
Element Id CatalogEntry.lastUpdated CatalogEntry.estimatedDuration
Definition

Typically date Estimated duration of issue is different from the beginning orderable item of this entry of the validity. This can be used to see when an item was last updated. catalog.

Cardinality 0..1
Type dateTime Duration
CatalogEntry.additionalCharacteristic CatalogEntry.billingCode
Element Id CatalogEntry.additionalCharacteristic CatalogEntry.billingCode
Definition

Used for examplefor Out Billing code associated to the item in the context of Formulary, or any specifics. this entry of the catalog.

Cardinality 0..*
Terminology Binding All CPT codes ( Example )
Type CodeableConcept
Summary true
CatalogEntry.additionalClassification CatalogEntry.billingSummary
Element Id CatalogEntry.additionalClassification CatalogEntry.billingSummary
Definition

User for example for ATC classification, or. Billing summary attached to the item in the context of this entry of the catalog.

Cardinality 0..* 0..1
Type CodeableConcept string
Summary true
CatalogEntry.relatedEntry CatalogEntry.scheduleSummary
Element Id CatalogEntry.relatedEntry CatalogEntry.scheduleSummary
Definition

Used Schedule summary for example, to point to a substance, or to a device used to administer a medication. the item in the context of this entry of the catalog.

Cardinality 0..* 0..1
Type string
CatalogEntry.relatedEntry.relationtype CatalogEntry.limitationSummary
Element Id CatalogEntry.relatedEntry.relationtype CatalogEntry.limitationSummary
Definition

The type Summary of relation to limitations for the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc. item in the context of this entry of the catalog.

Cardinality 1..1 Terminology Binding CatalogEntryRelationType ( Required ) 0..1
Type code string
CatalogEntry.relatedEntry.item CatalogEntry.regulatorySummary
Element Id CatalogEntry.relatedEntry.item CatalogEntry.regulatorySummary
Definition

The reference to Regulatory summary for the related item. item in the context of this entry of the catalog.

Cardinality 1..1 0..1
Type Reference ( CatalogEntry string )