Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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
CatalogEntry.identifier
Element IdCatalogEntry.identifier
Definition

Business identifier uniquely assigned to the catalog entry.

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

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

Cardinality0..1
Typestring
Summarytrue
CatalogEntry.type
Element IdCatalogEntry.type
Definition

The type of resource that is represented by this catalog entry.

Cardinality0..1
Terminology BindingCatalogEntryType (Required)
Typecode
Summarytrue
CatalogEntry.status
Element IdCatalogEntry.status
Definition

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

Cardinality0..1
Terminology BindingCatalogEntryStatus (Required)
Typecode
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
CatalogEntry.effectivePeriod
Element IdCatalogEntry.effectivePeriod
Definition

Period of usability of the catalog entry.

Cardinality0..1
TypePeriod
CatalogEntry.orderable
Element IdCatalogEntry.orderable
Definition

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

Cardinality1..1
Typeboolean
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
CatalogEntry.referencedItem
Element IdCatalogEntry.referencedItem
Definition

The item (resource) that this entry of the catalog represents.

Cardinality1..1
TypeReference(DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | MedicationKnowledge | Substance | Location)
PatternsReference(DeviceDefinition,Organization,Practitioner,PractitionerRole,HealthcareService,ActivityDefinition,PlanDefinition,SpecimenDefinition,ObservationDefinition,MedicationKnowledge,Substance,Location): No common pattern
Summarytrue
CatalogEntry.relatedEntry
Element IdCatalogEntry.relatedEntry
Definition

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

Cardinality0..*
CatalogEntry.relatedEntry.relationship
Element IdCatalogEntry.relatedEntry.relationship
Definition

The type of relationship to the related entry.

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

The reference to the related entry.

Cardinality1..1
TypeReference(CatalogEntry)
CatalogEntry.updatedBy
Element IdCatalogEntry.updatedBy
Definition

Last actor who recorded (created or updated) this catalog entry.

Cardinality0..1
TypeReference(Person | Device)
PatternsReference(Person,Device): No common pattern
CatalogEntry.note
Element IdCatalogEntry.note
Definition

Notes and comments about this catalog entry.

Cardinality0..*
TypeAnnotation
CatalogEntry.estimatedDuration
Element IdCatalogEntry.estimatedDuration
Definition

Estimated duration of the orderable item of this entry of the catalog.

Cardinality0..1
TypeDuration
CatalogEntry.billingCode
Element IdCatalogEntry.billingCode
Definition

Billing code associated to the item in the context of this entry of the catalog.

Cardinality0..*
Terminology BindingAll CPT codes (Example)
TypeCodeableConcept
Summarytrue
CatalogEntry.billingSummary
Element IdCatalogEntry.billingSummary
Definition

Billing summary attached to the item in the context of this entry of the catalog.

Cardinality0..1
Typestring
Summarytrue
CatalogEntry.scheduleSummary
Element IdCatalogEntry.scheduleSummary
Definition

Schedule summary for the item in the context of this entry of the catalog.

Cardinality0..1
Typestring
CatalogEntry.limitationSummary
Element IdCatalogEntry.limitationSummary
Definition

Summary of limitations for the item in the context of this entry of the catalog.

Cardinality0..1
Typestring
CatalogEntry.regulatorySummary
Element IdCatalogEntry.regulatorySummary
Definition

Regulatory summary for the item in the context of this entry of the catalog.

Cardinality0..1
Typestring