Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. 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

Orders and Observations Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the CatalogEntry resource.

CatalogEntry
Element IdCatalogEntry
Definition

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

Cardinality0..*
TypeDomainResource
Summaryfalse
CatalogEntry.identifier
Element IdCatalogEntry.identifier
Definition

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
CatalogEntry.type
Element IdCatalogEntry.type
Definition

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

Cardinality0..1
TypeCodeableConcept
Summaryfalse
CatalogEntry.orderable
Element IdCatalogEntry.orderable
Definition

Whether the entry represents an orderable item.

Cardinality1..1
Typeboolean
Summarytrue
CatalogEntry.referencedItem
Element IdCatalogEntry.referencedItem
Definition

The item in a catalog or definition.

Cardinality1..1
TypeReference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary)
Summarytrue
CatalogEntry.additionalIdentifier
Element IdCatalogEntry.additionalIdentifier
Definition

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

Cardinality0..*
TypeIdentifier
Summaryfalse
CatalogEntry.classification
Element IdCatalogEntry.classification
Definition

Classes of devices, or ATC for medication.

Cardinality0..*
TypeCodeableConcept
Summaryfalse
CatalogEntry.status
Element IdCatalogEntry.status
Definition

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

Cardinality0..1
Terminology BindingPublicationStatus (Required)
Typecode
Summaryfalse
CatalogEntry.validityPeriod
Element IdCatalogEntry.validityPeriod
Definition

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

Cardinality0..1
TypePeriod
Summaryfalse
CatalogEntry.validTo
Element IdCatalogEntry.validTo
Definition

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

Cardinality0..1
TypedateTime
Summaryfalse
CatalogEntry.lastUpdated
Element IdCatalogEntry.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.

Cardinality0..1
TypedateTime
Summaryfalse
Comments

Perhaps not needed - if we use fhir resource metadata.

CatalogEntry.additionalCharacteristic
Element IdCatalogEntry.additionalCharacteristic
Definition

Used for examplefor Out of Formulary, or any specifics.

Cardinality0..*
TypeCodeableConcept
Summaryfalse
CatalogEntry.additionalClassification
Element IdCatalogEntry.additionalClassification
Definition

User for example for ATC classification, or.

Cardinality0..*
TypeCodeableConcept
Summaryfalse
CatalogEntry.relatedEntry
Element IdCatalogEntry.relatedEntry
Definition

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

Cardinality0..*
Summaryfalse
CatalogEntry.relatedEntry.relationtype
Element IdCatalogEntry.relatedEntry.relationtype
Definition

The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

Cardinality1..1
Terminology BindingCatalogEntryRelationType (Required)
Typecode
Summaryfalse
CatalogEntry.relatedEntry.item
Element IdCatalogEntry.relatedEntry.item
Definition

The reference to the related item.

Cardinality1..1
TypeReference(CatalogEntry)
Summaryfalse