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

8.28 Resource CatalogEntry - Content

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

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

8.28.1 Scope and Usage

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:

  • A pharmacy formulary
  • A laboratory compendium
  • A radiology compendium of exams that may be ordered
  • A dietary nutrition order catalog
  • A supply charge master
  • A CDS catalog of knowledge artifacts

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.

8.28.2 Boundaries and Relationships

This CatalogEntry resource wraps and contextualizes definitional items that make up a catalog such as the following resources:

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.

8.28.3 References

This resource is referenced by itself.

This resource does not implement any patterns.

8.28.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CatalogEntry TUDomainResourceAn entry in a catalog
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierUnique identifier of the catalog item
... type 0..1CodeableConceptThe type of item - medication, device, service, protocol or other
... orderable Σ1..1booleanWhether the entry represents an orderable item
... additionalIdentifier 0..*IdentifierAny additional identifier(s) for the catalog item, in the same granularity or concept
... classification 0..*CodeableConceptClassification (category or class) of the item entry
... status 0..1codedraft | active | retired | unknown
PublicationStatus (Required)
... validityPeriod 0..1PeriodThe time period in which this catalog entry is expected to be active
... validTo 0..1dateTimeThe date until which this catalog entry is expected to be active
... lastUpdated 0..1dateTimeWhen was this catalog last updated
... additionalCharacteristic 0..*CodeableConceptAdditional characteristics of the catalog entry
... additionalClassification 0..*CodeableConceptAdditional classification of the catalog entry
... relatedEntry 0..*BackboneElementAn item that this catalog entry is related to
.... relationtype 1..1codetriggers | is-replaced-by
CatalogEntryRelationType (Required)
.... item 1..1Reference(CatalogEntry)The reference to the related item

doco Documentation for this format

UML Diagram (Legend)

CatalogEntry (DomainResource)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer codeidentifier : Identifier [0..*]The type of item - medication, device, service, protocol or othertype : CodeableConcept [0..1]Whether the entry represents an orderable itemorderable : boolean [1..1]The item in a catalog or definitionreferencedItem : Reference [1..1] « Medication|Device|Organization| Practitioner|PractitionerRole|HealthcareService| ActivityDefinition|PlanDefinition|SpecimenDefinition| ObservationDefinition|Binary »Used in supporting related concepts, e.g. NDC to RxNormadditionalIdentifier : Identifier [0..*]Classes of devices, or ATC for medicationclassification : CodeableConcept [0..*]Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribablestatus : code [0..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The time period in which this catalog entry is expected to be activevalidityPeriod : Period [0..1]The date until which this catalog entry is expected to be activevalidTo : dateTime [0..1]Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updatedlastUpdated : dateTime [0..1]Used for examplefor Out of Formulary, or any specificsadditionalCharacteristic : CodeableConcept [0..*]User for example for ATC classification, oradditionalClassification : CodeableConcept [0..*]RelatedEntryThe type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etcrelationtype : code [1..1] « The type of relations between entries. (Strength=Required)CatalogEntryRelationType! »The reference to the related itemitem : Reference [1..1] « CatalogEntry »Used for example, to point to a substance, or to a device used to administer a medicationrelatedEntry[0..*]

XML Template

<CatalogEntry xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier of the catalog item --></identifier>
 <type><!-- 0..1 CodeableConcept The type of item - medication, device, service, protocol or other --></type>
 <orderable value="[boolean]"/><!-- 1..1 Whether the entry represents an orderable item -->
 <referencedItem><!-- 1..1 Reference(ActivityDefinition|Binary|Device|
   HealthcareService|Medication|ObservationDefinition|Organization|
   PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition) The item that is being defined --></referencedItem>
 <additionalIdentifier><!-- 0..* Identifier Any additional identifier(s) for the catalog item, in the same granularity or concept --></additionalIdentifier>
 <classification><!-- 0..* CodeableConcept Classification (category or class) of the item entry --></classification>
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <validityPeriod><!-- 0..1 Period The time period in which this catalog entry is expected to be active --></validityPeriod>
 <validTo value="[dateTime]"/><!-- 0..1 The date until which this catalog entry is expected to be active -->
 <lastUpdated value="[dateTime]"/><!-- 0..1 When was this catalog last updated -->
 <additionalCharacteristic><!-- 0..* CodeableConcept Additional characteristics of the catalog entry --></additionalCharacteristic>
 <additionalClassification><!-- 0..* CodeableConcept Additional classification of the catalog entry --></additionalClassification>
 <relatedEntry>  <!-- 0..* An item that this catalog entry is related to -->
  <relationtype value="[code]"/><!-- 1..1 triggers | is-replaced-by -->
  <item><!-- 1..1 Reference(CatalogEntry) The reference to the related item --></item>
 </relatedEntry>
</CatalogEntry>

JSON Template

{doco
  "resourceType" : "CatalogEntry",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier of the catalog item
  "type" : { CodeableConcept }, // The type of item - medication, device, service, protocol or other
  "orderable" : <boolean>, // R!  Whether the entry represents an orderable item
  "referencedItem" : { Reference(ActivityDefinition|Binary|Device|
   HealthcareService|Medication|ObservationDefinition|Organization|
   PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition) }, // R!  The item that is being defined
  "additionalIdentifier" : [{ Identifier }], // Any additional identifier(s) for the catalog item, in the same granularity or concept
  "classification" : [{ CodeableConcept }], // Classification (category or class) of the item entry
  "status" : "<code>", // draft | active | retired | unknown
  "validityPeriod" : { Period }, // The time period in which this catalog entry is expected to be active
  "validTo" : "<dateTime>", // The date until which this catalog entry is expected to be active
  "lastUpdated" : "<dateTime>", // When was this catalog last updated
  "additionalCharacteristic" : [{ CodeableConcept }], // Additional characteristics of the catalog entry
  "additionalClassification" : [{ CodeableConcept }], // Additional classification of the catalog entry
  "relatedEntry" : [{ // An item that this catalog entry is related to
    "relationtype" : "<code>", // R!  triggers | is-replaced-by
    "item" : { Reference(CatalogEntry) } // R!  The reference to the related item
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:CatalogEntry;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:CatalogEntry.identifier [ Identifier ], ... ; # 0..* Unique identifier of the catalog item
  fhir:CatalogEntry.type [ CodeableConcept ]; # 0..1 The type of item - medication, device, service, protocol or other
  fhir:CatalogEntry.orderable [ boolean ]; # 1..1 Whether the entry represents an orderable item
  fhir:CatalogEntry.referencedItem [ Reference(ActivityDefinition|Binary|Device|HealthcareService|Medication|
  ObservationDefinition|Organization|PlanDefinition|Practitioner|
  PractitionerRole|SpecimenDefinition) ]; # 1..1 The item that is being defined
  fhir:CatalogEntry.additionalIdentifier [ Identifier ], ... ; # 0..* Any additional identifier(s) for the catalog item, in the same granularity or concept
  fhir:CatalogEntry.classification [ CodeableConcept ], ... ; # 0..* Classification (category or class) of the item entry
  fhir:CatalogEntry.status [ code ]; # 0..1 draft | active | retired | unknown
  fhir:CatalogEntry.validityPeriod [ Period ]; # 0..1 The time period in which this catalog entry is expected to be active
  fhir:CatalogEntry.validTo [ dateTime ]; # 0..1 The date until which this catalog entry is expected to be active
  fhir:CatalogEntry.lastUpdated [ dateTime ]; # 0..1 When was this catalog last updated
  fhir:CatalogEntry.additionalCharacteristic [ CodeableConcept ], ... ; # 0..* Additional characteristics of the catalog entry
  fhir:CatalogEntry.additionalClassification [ CodeableConcept ], ... ; # 0..* Additional classification of the catalog entry
  fhir:CatalogEntry.relatedEntry [ # 0..* An item that this catalog entry is related to
    fhir:CatalogEntry.relatedEntry.relationtype [ code ]; # 1..1 triggers | is-replaced-by
    fhir:CatalogEntry.relatedEntry.item [ Reference(CatalogEntry) ]; # 1..1 The reference to the related item
  ], ...;
]

Changes since R3

CatalogEntry
CatalogEntry.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0
CatalogEntry.relatedEntry.relationtype
  • Change value set from http://hl7.org/fhir/ValueSet/relation-type|4.0.0 to http://hl7.org/fhir/ValueSet/relation-type|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CatalogEntry TUDomainResourceAn entry in a catalog
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierUnique identifier of the catalog item
... type 0..1CodeableConceptThe type of item - medication, device, service, protocol or other
... orderable Σ1..1booleanWhether the entry represents an orderable item
... additionalIdentifier 0..*IdentifierAny additional identifier(s) for the catalog item, in the same granularity or concept
... classification 0..*CodeableConceptClassification (category or class) of the item entry
... status 0..1codedraft | active | retired | unknown
PublicationStatus (Required)
... validityPeriod 0..1PeriodThe time period in which this catalog entry is expected to be active
... validTo 0..1dateTimeThe date until which this catalog entry is expected to be active
... lastUpdated 0..1dateTimeWhen was this catalog last updated
... additionalCharacteristic 0..*CodeableConceptAdditional characteristics of the catalog entry
... additionalClassification 0..*CodeableConceptAdditional classification of the catalog entry
... relatedEntry 0..*BackboneElementAn item that this catalog entry is related to
.... relationtype 1..1codetriggers | is-replaced-by
CatalogEntryRelationType (Required)
.... item 1..1Reference(CatalogEntry)The reference to the related item

doco Documentation for this format

UML Diagram (Legend)

CatalogEntry (DomainResource)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer codeidentifier : Identifier [0..*]The type of item - medication, device, service, protocol or othertype : CodeableConcept [0..1]Whether the entry represents an orderable itemorderable : boolean [1..1]The item in a catalog or definitionreferencedItem : Reference [1..1] « Medication|Device|Organization| Practitioner|PractitionerRole|HealthcareService| ActivityDefinition|PlanDefinition|SpecimenDefinition| ObservationDefinition|Binary »Used in supporting related concepts, e.g. NDC to RxNormadditionalIdentifier : Identifier [0..*]Classes of devices, or ATC for medicationclassification : CodeableConcept [0..*]Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribablestatus : code [0..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The time period in which this catalog entry is expected to be activevalidityPeriod : Period [0..1]The date until which this catalog entry is expected to be activevalidTo : dateTime [0..1]Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updatedlastUpdated : dateTime [0..1]Used for examplefor Out of Formulary, or any specificsadditionalCharacteristic : CodeableConcept [0..*]User for example for ATC classification, oradditionalClassification : CodeableConcept [0..*]RelatedEntryThe type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etcrelationtype : code [1..1] « The type of relations between entries. (Strength=Required)CatalogEntryRelationType! »The reference to the related itemitem : Reference [1..1] « CatalogEntry »Used for example, to point to a substance, or to a device used to administer a medicationrelatedEntry[0..*]

XML Template

<CatalogEntry xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier of the catalog item --></identifier>
 <type><!-- 0..1 CodeableConcept The type of item - medication, device, service, protocol or other --></type>
 <orderable value="[boolean]"/><!-- 1..1 Whether the entry represents an orderable item -->
 <referencedItem><!-- 1..1 Reference(ActivityDefinition|Binary|Device|
   HealthcareService|Medication|ObservationDefinition|Organization|
   PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition) The item that is being defined --></referencedItem>
 <additionalIdentifier><!-- 0..* Identifier Any additional identifier(s) for the catalog item, in the same granularity or concept --></additionalIdentifier>
 <classification><!-- 0..* CodeableConcept Classification (category or class) of the item entry --></classification>
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <validityPeriod><!-- 0..1 Period The time period in which this catalog entry is expected to be active --></validityPeriod>
 <validTo value="[dateTime]"/><!-- 0..1 The date until which this catalog entry is expected to be active -->
 <lastUpdated value="[dateTime]"/><!-- 0..1 When was this catalog last updated -->
 <additionalCharacteristic><!-- 0..* CodeableConcept Additional characteristics of the catalog entry --></additionalCharacteristic>
 <additionalClassification><!-- 0..* CodeableConcept Additional classification of the catalog entry --></additionalClassification>
 <relatedEntry>  <!-- 0..* An item that this catalog entry is related to -->
  <relationtype value="[code]"/><!-- 1..1 triggers | is-replaced-by -->
  <item><!-- 1..1 Reference(CatalogEntry) The reference to the related item --></item>
 </relatedEntry>
</CatalogEntry>

JSON Template

{doco
  "resourceType" : "CatalogEntry",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier of the catalog item
  "type" : { CodeableConcept }, // The type of item - medication, device, service, protocol or other
  "orderable" : <boolean>, // R!  Whether the entry represents an orderable item
  "referencedItem" : { Reference(ActivityDefinition|Binary|Device|
   HealthcareService|Medication|ObservationDefinition|Organization|
   PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition) }, // R!  The item that is being defined
  "additionalIdentifier" : [{ Identifier }], // Any additional identifier(s) for the catalog item, in the same granularity or concept
  "classification" : [{ CodeableConcept }], // Classification (category or class) of the item entry
  "status" : "<code>", // draft | active | retired | unknown
  "validityPeriod" : { Period }, // The time period in which this catalog entry is expected to be active
  "validTo" : "<dateTime>", // The date until which this catalog entry is expected to be active
  "lastUpdated" : "<dateTime>", // When was this catalog last updated
  "additionalCharacteristic" : [{ CodeableConcept }], // Additional characteristics of the catalog entry
  "additionalClassification" : [{ CodeableConcept }], // Additional classification of the catalog entry
  "relatedEntry" : [{ // An item that this catalog entry is related to
    "relationtype" : "<code>", // R!  triggers | is-replaced-by
    "item" : { Reference(CatalogEntry) } // R!  The reference to the related item
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:CatalogEntry;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:CatalogEntry.identifier [ Identifier ], ... ; # 0..* Unique identifier of the catalog item
  fhir:CatalogEntry.type [ CodeableConcept ]; # 0..1 The type of item - medication, device, service, protocol or other
  fhir:CatalogEntry.orderable [ boolean ]; # 1..1 Whether the entry represents an orderable item
  fhir:CatalogEntry.referencedItem [ Reference(ActivityDefinition|Binary|Device|HealthcareService|Medication|
  ObservationDefinition|Organization|PlanDefinition|Practitioner|
  PractitionerRole|SpecimenDefinition) ]; # 1..1 The item that is being defined
  fhir:CatalogEntry.additionalIdentifier [ Identifier ], ... ; # 0..* Any additional identifier(s) for the catalog item, in the same granularity or concept
  fhir:CatalogEntry.classification [ CodeableConcept ], ... ; # 0..* Classification (category or class) of the item entry
  fhir:CatalogEntry.status [ code ]; # 0..1 draft | active | retired | unknown
  fhir:CatalogEntry.validityPeriod [ Period ]; # 0..1 The time period in which this catalog entry is expected to be active
  fhir:CatalogEntry.validTo [ dateTime ]; # 0..1 The date until which this catalog entry is expected to be active
  fhir:CatalogEntry.lastUpdated [ dateTime ]; # 0..1 When was this catalog last updated
  fhir:CatalogEntry.additionalCharacteristic [ CodeableConcept ], ... ; # 0..* Additional characteristics of the catalog entry
  fhir:CatalogEntry.additionalClassification [ CodeableConcept ], ... ; # 0..* Additional classification of the catalog entry
  fhir:CatalogEntry.relatedEntry [ # 0..* An item that this catalog entry is related to
    fhir:CatalogEntry.relatedEntry.relationtype [ code ]; # 1..1 triggers | is-replaced-by
    fhir:CatalogEntry.relatedEntry.item [ Reference(CatalogEntry) ]; # 1..1 The reference to the related item
  ], ...;
]

Changes since Release 3

CatalogEntry
CatalogEntry.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0
CatalogEntry.relatedEntry.relationtype
  • Change value set from http://hl7.org/fhir/ValueSet/relation-type|4.0.0 to http://hl7.org/fhir/ValueSet/relation-type|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

8.28.4.1 Terminology Bindings

PathDefinitionTypeReference
CatalogEntry.status The lifecycle status of an artifact.RequiredPublicationStatus
CatalogEntry.relatedEntry.relationtype The type of relations between entries.RequiredCatalogEntryRelationType