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 Resource CatalogEntry - Content

Orders and Observations Work Group Maturity Level : 0   Trial Use Security 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 to organize resources representing the following types definition of clinical collections, including but not limited to: {products|services|knowledge artifacts|plans|observations|chemical or biological substances|professionals|roles|organizations|locations|physical objects} within catalogs or compendia assisting practitioners and|or patients in processes of healthcare delivery.

Examples of such catalogs include:

  • A a pharmacy formulary
  • A a laboratory procedures compendium
  • A a radiology procedures compendium of exams that may be ordered
  • A a dietary nutrition order catalog
  • A a supply charge master
  • A a CDS catalog of knowledge artifacts
  • a directory of healthcare services
  • a manufacturer catalog of medical devices
  • the list of tests that an in vitro diagnostic device is able to perform

The Catalog profile A catalog or compendium for healthcare is represented in FHIR as an instance of the Composition resource, constrained by the Catalog profile. Such a resource is used to organize catalog entries. contains nestable sections, each of which contains a number of entry elements referencing CatalogEntry resources.

Catalogs are composed Thus, a CatalogEntry resource represents an entry of nestable sections which contain catalog entries. Catalog entries wrap the items that are orderable or selectable in a Catalog. It acts as a wrapper that contextualizes the inclusion into the catalog and any other required supporting entries. Examples of information provided an item (product, service, artifact, location ...) directly orderable/selectable by catalog consumers.

The CatalogEntry includes whether specifies the period of usability of the item by consumers of the catalog. It holds the current status of the item in the catalog is "active", "inactive", "legacy", or "informative" or whether as well as its orderability, the charges, limitations, constraints and regulations associated with the item is an orderable item in the context of this catalog (or catalog section). catalog. CatalogEntry facilitates the relation between maintenance of 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 over time, enabling to the Boundaries retire entries and Relationships part of this document for more information on the topic. to replace them by others, tracking who updates them.

8.28.2 Boundaries and Relationships

This CatalogEntry resource wraps and contextualizes definitional items that make up a catalog such as the following resources: Medication Device Activity Definition (including laboratory service definitions) Specimen Definition ...

It is important to note that CatalogEntry shall does 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 does 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. in the context of this catalog. Catalog entries can also be related to one another. Here again, it is important to note that only Only relationships that hold within the context of a catalog and not generally for the item items referenced by the catalog entry should be considered. entries are supported this way. For instance, in the context of a given laboratory service compendium, a laboratory order orderable service may be preferred over other laboratory orders. services. The other laboratory orders services in this use case may thus be related to the preferred test service using an 'is-replaced-by' relationship and assigned a new status of 'retired'. Other Conversely, 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 orderable procedures often state the required input observation specifications, the format of the expected observation output, and the attributes of the required specimen and such specimens. These kind of relationships are probably best described outside of the CatalogEntry within the referenced item.

CatalogEntry is referenced by Composition.section[.section]*.entry, where Composition is constrained by the Catalog profile. CatalogEntry may also be referenced by CatalogEntry.relatedEntry.target, enabling entries of the catalog to refer to other entries that supersede them, or that may be automatically included at time of ordering or reporting.

CatalogEntry.referencedItem references the resource representing the definitional item hooked to an entry of the catalog. The types of resources supported are: DeviceDefinition, Organization, Practitioner, PractitionerRole, HealthcareService, ActivityDefinition, PlanDefinition, SpecimenDefinition, ObservationDefinition, MedicationKnowledge, Medication, Substance, Location.

8.28.3 References

This resource is referenced by itself itself.

This resource does not implement any patterns.

8.28.3 8.28.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . CatalogEntry TU DomainResource An entry in a catalog
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Unique Business identifier of the catalog item entry
. . type . name Σ 0..1 CodeableConcept string The type of item - medication, device, service, protocol or other Displayable name assigned to the catalog entry
. . . orderable type Σ 1..1 0..1 boolean code Whether the ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
CatalogEntryType ( Required )
... effectivePeriod 0..1 Period When this catalog entry represents an orderable item is expected to be active
. . referencedItem . orderable ?! Σ 1..1 boolean Is orderable
... referencedItem Σ 1..1 Reference ( Medication | Device DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary ) The item that is being defined additionalIdentifier MedicationKnowledge | Substance 0..* Identifier | Location ) Any additional identifier(s) for Item attached to this entry of the catalog item, in the same granularity or concept
. . classification . relatedEntry 0..* CodeableConcept BackboneElement Classification (category or class) Another entry of the item entry catalog related to this one
. . . . status relationship 0..1 1..1 code draft triggers | active is-replaced-by | retired excludes | unknown includes
PublicationStatus CatalogEntryRelationType ( Required )
. . validityPeriod . . target 0..1 1..1 Period Reference ( CatalogEntry ) The time period in which this catalog entry is expected reference to be active the related entry
. . validTo . updatedBy 0..1 dateTime Reference ( Person | Device ) The date until which Last updater of this catalog entry is expected to be active
. . lastUpdated . note 0..1 0..* dateTime Annotation When was Notes and comments about this catalog last updated entry
. . . additionalCharacteristic estimatedDuration 0..* 0..1 CodeableConcept Duration Additional characteristics Estimated duration of the catalog entry orderable item
. . . additionalClassification billingCode Σ 0..* CodeableConcept Additional classification of Billing code in the context of this catalog entry
All CPT codes ( Example )
. . relatedEntry . billingSummary Σ 0..* 0..1 BackboneElement string An item that Billing summary in the context of this catalog entry is related to
. . . relationtype scheduleSummary 1..1 0..1 code string triggers | is-replaced-by CatalogEntryRelationType ( Required ) Schedule summary for the catalog entry
. . item . limitationSummary 1..1 0..1 Reference ( CatalogEntry string ) The reference to Summary of limitations for the related item catalog entry
... regulatorySummary 0..1 string Regulatory summary for the catalog entry

doco Documentation for this format

UML Diagram ( Legend )

CatalogEntry ( DomainResource ) Used in supporting different identifiers for Business identifier uniquely assigned to the same product, e.g. manufacturer code and retailer code catalog entry identifier : Identifier [0..*] The type name of this catalog entry announces the item - medication, device, service, protocol that is represented by the entry name : string [0..1] The type of resource that is represented by this catalog entry type : code [0..1] « Types of resources that can be attached to catalog entries. (Strength=Required) CatalogEntryType ! » Indicates whether this catalog entry is open to public usage (active) or not (draft or retired) (this element modifies the meaning of other elements) type status : CodeableConcept code [0..1] « Public usability statuses for catalog entries. (Strength=Required) CatalogEntryStatus ! » Whether Period of usability of the catalog entry effectivePeriod : Period [0..1] Indicates whether or not the entry represents an orderable item that is orderable (this element modifies the meaning of other elements) orderable : boolean [1..1] The item in a (resource) that this entry of the catalog or definition represents referencedItem : Reference [1..1] « Medication | Device DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary MedicationKnowledge | Substance | Location » Used in supporting related concepts, e.g. NDC to RxNorm Last actor who recorded (created or updated) this catalog entry additionalIdentifier updatedBy : Identifier Reference [0..*] [0..1] « Person | Device » Classes of devices, or ATC for medication Notes and comments about this catalog entry classification note : CodeableConcept Annotation [0..*] Used to support catalog exchange even for unsupported products, e.g. getting list Estimated duration of medications even if not prescribable the orderable item of this entry of the catalog status estimatedDuration : code Duration [0..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » The time period Billing code associated to the item in which the context of this catalog entry is expected to be active of the catalog validityPeriod billingCode : Period CodeableConcept [0..1] [0..*] « Billing codes for entries of catalogs of orderable items. (Strength=Example) All CPT ?? » The date until which Billing summary attached to the item in the context of this catalog entry is expected to be active of the catalog validTo billingSummary : dateTime string [0..1] Typically date of issue is different from Schedule summary for the beginning item in the context of this entry of the validity. This can be used to see when an item was last updated catalog lastUpdated scheduleSummary : dateTime string [0..1] Used Summary of limitations for examplefor Out the item in the context of Formulary, or any specifics this entry of the catalog additionalCharacteristic limitationSummary : CodeableConcept string [0..*] [0..1] User for example Regulatory summary for ATC classification, or the item in the context of this entry of the catalog additionalClassification regulatorySummary : CodeableConcept string [0..*] [0..1] RelatedEntry The type of relation relationship to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc entry relationtype relationship : code [1..1] « The type Types of relations relationships between entries. (Strength=Required) CatalogEntryRelationType ! » The reference to the related item entry item target : Reference [1..1] « CatalogEntry » Used for example, to point to a substance, or to a device used to administer a medication relatedEntry [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>
 <</type>
 <
 <|
   |
   </referencedItem>
 <</additionalIdentifier>
 <</classification>
 <
 <</validityPeriod>
 <
 <
 <</additionalCharacteristic>
 <</additionalClassification>
 <
  <
  <</item>

 <identifier><!-- 0..* Identifier Business identifier of the catalog entry --></identifier>
 <name value="[string]"/><!-- 0..1 Displayable name assigned to the catalog entry -->
 <type value="[code]"/><!-- 0..1 ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location -->
 <status value="[code]"/><!-- 0..1 draft | active | retired -->
 <effectivePeriod><!-- 0..1 Period When this catalog entry is expected to be active --></effectivePeriod>
 <orderable value="[boolean]"/><!-- 1..1 Is orderable -->
 <referencedItem><!-- 1..1 Reference(ActivityDefinition|DeviceDefinition|
   HealthcareService|Location|MedicationKnowledge|ObservationDefinition|
   Organization|PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition|
   Substance) Item attached to this entry of the catalog --></referencedItem>

 <relatedEntry>  <!-- 0..* Another entry of the catalog related to this one -->
  <relationship value="[code]"/><!-- 1..1 triggers | is-replaced-by | excludes | includes -->
  <target><!-- 1..1 Reference(CatalogEntry) The reference to the related entry --></target>

 </relatedEntry>
 <updatedBy><!-- 0..1 Reference(Device|Person) Last updater of this catalog entry --></updatedBy>
 <note><!-- 0..* Annotation Notes and comments about this catalog entry --></note>
 <estimatedDuration><!-- 0..1 Duration Estimated duration of the orderable item --></estimatedDuration>
 <billingCode><!-- 0..* CodeableConcept Billing code in the context of this catalog entry --></billingCode>
 <billingSummary value="[string]"/><!-- 0..1 Billing summary in the context of this catalog entry -->
 <scheduleSummary value="[string]"/><!-- 0..1 Schedule summary for the catalog entry -->
 <limitationSummary value="[string]"/><!-- 0..1 Summary of limitations for the catalog entry -->
 <regulatorySummary value="[string]"/><!-- 0..1 Regulatory  summary for the catalog entry -->

</CatalogEntry>

JSON Template 

{doco
  "resourceType" : "CatalogEntry",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "|
   |
   
  "
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
  }]

  "identifier" : [{ Identifier }], // Business identifier of the catalog entry
  "name" : "<string>", // Displayable name assigned to the catalog entry
  "type" : "<code>", // ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
  "status" : "<code>", // draft | active | retired
  "effectivePeriod" : { Period }, // When this catalog entry is expected to be active
  "orderable" : <boolean>, // R!  Is orderable
  "referencedItem" : { Reference(ActivityDefinition|DeviceDefinition|
   HealthcareService|Location|MedicationKnowledge|ObservationDefinition|
   Organization|PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition|
   Substance) }, // R!  Item attached to this entry of the catalog

  "relatedEntry" : [{ // Another entry of the catalog related to this one
    "relationship" : "<code>", // R!  triggers | is-replaced-by | excludes | includes
    "target" : { Reference(CatalogEntry) } // R!  The reference to the related entry
  }],
  "updatedBy" : { Reference(Device|Person) }, // Last updater of this catalog entry
  "note" : [{ Annotation }], // Notes and comments about this catalog entry
  "estimatedDuration" : { Duration }, // Estimated duration of the orderable item
  "billingCode" : [{ CodeableConcept }], // Billing code in the context of this catalog entry
  "billingSummary" : "<string>", // Billing summary in the context of this catalog entry
  "scheduleSummary" : "<string>", // Schedule summary for the catalog entry
  "limitationSummary" : "<string>", // Summary of limitations for the catalog entry
  "regulatorySummary" : "<string>" // Regulatory  summary for the catalog entry

}

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:
  fhir:
  fhir:
  fhir:|
  |
  
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:

  fhir:CatalogEntry.identifier [ Identifier ], ... ; # 0..* Business identifier of the catalog entry
  fhir:CatalogEntry.name [ string ]; # 0..1 Displayable name assigned to the catalog entry
  fhir:CatalogEntry.type [ code ]; # 0..1 ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
  fhir:CatalogEntry.status [ code ]; # 0..1 draft | active | retired
  fhir:CatalogEntry.effectivePeriod [ Period ]; # 0..1 When this catalog entry is expected to be active
  fhir:CatalogEntry.orderable [ boolean ]; # 1..1 Is orderable
  fhir:CatalogEntry.referencedItem [ Reference(ActivityDefinition|DeviceDefinition|HealthcareService|Location|
  MedicationKnowledge|ObservationDefinition|Organization|PlanDefinition|
  Practitioner|PractitionerRole|SpecimenDefinition|Substance) ]; # 1..1 Item attached to this entry of the catalog

  fhir:CatalogEntry.relatedEntry [ # 0..* Another entry of the catalog related to this one
    fhir:CatalogEntry.relatedEntry.relationship [ code ]; # 1..1 triggers | is-replaced-by | excludes | includes
    fhir:CatalogEntry.relatedEntry.target [ Reference(CatalogEntry) ]; # 1..1 The reference to the related entry

  ], ...;
  fhir:CatalogEntry.updatedBy [ Reference(Device|Person) ]; # 0..1 Last updater of this catalog entry
  fhir:CatalogEntry.note [ Annotation ], ... ; # 0..* Notes and comments about this catalog entry
  fhir:CatalogEntry.estimatedDuration [ Duration ]; # 0..1 Estimated duration of the orderable item
  fhir:CatalogEntry.billingCode [ CodeableConcept ], ... ; # 0..* Billing code in the context of this catalog entry
  fhir:CatalogEntry.billingSummary [ string ]; # 0..1 Billing summary in the context of this catalog entry
  fhir:CatalogEntry.scheduleSummary [ string ]; # 0..1 Schedule summary for the catalog entry
  fhir:CatalogEntry.limitationSummary [ string ]; # 0..1 Summary of limitations for the catalog entry
  fhir:CatalogEntry.regulatorySummary [ string ]; # 0..1 Regulatory  summary for the catalog entry

]

Changes since R3

CatalogEntry
CatalogEntry.name
  • Added Element
CatalogEntry.type
  • Type changed from CodeableConcept to code
  • Add Binding http://hl7.org/fhir/ValueSet/catalogentry-type|4.2.0 (required)
CatalogEntry.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/catalogentry-status|4.2.0
  • Now marked as Modifier
CatalogEntry.effectivePeriod
  • Added Element
CatalogEntry.orderable
  • Now marked as Modifier
CatalogEntry.referencedItem
  • Type Reference: Added Target Types DeviceDefinition, MedicationKnowledge, Substance, Location
  • Type Reference: Removed Target Types Medication, Device, Binary
CatalogEntry.relatedEntry.relationship
  • Added Mandatory Element
CatalogEntry.relatedEntry.target
  • Added Mandatory Element
CatalogEntry.updatedBy
  • Added Element
CatalogEntry.note
  • Added Element
CatalogEntry.estimatedDuration
  • Added Element
CatalogEntry.billingCode
  • Added Element
CatalogEntry.billingSummary
  • Added Element
CatalogEntry.scheduleSummary
  • Added Element
CatalogEntry.limitationSummary
  • Added Element
CatalogEntry.regulatorySummary
  • Added Element
CatalogEntry.additionalIdentifier
  • deleted
CatalogEntry.classification
  • deleted
CatalogEntry.validityPeriod
  • deleted
CatalogEntry.validTo
  • deleted
CatalogEntry.lastUpdated
  • deleted
CatalogEntry.additionalCharacteristic
  • deleted
CatalogEntry.additionalClassification
  • deleted
CatalogEntry.relatedEntry.relationtype
  • deleted
CatalogEntry.relatedEntry.item
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints doco
. . CatalogEntry TU DomainResource An entry in a catalog
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Unique Business identifier of the catalog item entry
. . type . name Σ 0..1 CodeableConcept string The type of item - medication, device, service, protocol or other Displayable name assigned to the catalog entry
. . . orderable type Σ 1..1 0..1 boolean code Whether the ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
CatalogEntryType ( Required )
... effectivePeriod 0..1 Period When this catalog entry represents an orderable item is expected to be active
. . referencedItem . orderable ?! Σ 1..1 boolean Is orderable
... referencedItem Σ 1..1 Reference ( Medication | Device DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary ) The item that is being defined additionalIdentifier MedicationKnowledge | Substance 0..* Identifier | Location ) Any additional identifier(s) for Item attached to this entry of the catalog item, in the same granularity or concept
. . classification . relatedEntry 0..* CodeableConcept BackboneElement Classification (category or class) Another entry of the item entry catalog related to this one
. . . . status relationship 0..1 1..1 code draft triggers | active is-replaced-by | retired excludes | unknown includes
PublicationStatus CatalogEntryRelationType ( Required )
. . validityPeriod . . target 0..1 1..1 Period Reference ( CatalogEntry ) The time period in which this catalog entry is expected reference to be active the related entry
. . validTo . updatedBy 0..1 dateTime Reference ( Person | Device ) The date until which Last updater of this catalog entry is expected to be active
. . lastUpdated . note 0..1 0..* dateTime Annotation When was Notes and comments about this catalog last updated entry
. . . additionalCharacteristic estimatedDuration 0..* 0..1 CodeableConcept Duration Additional characteristics Estimated duration of the catalog entry orderable item
. . . additionalClassification billingCode Σ 0..* CodeableConcept Additional classification of Billing code in the context of this catalog entry
All CPT codes ( Example )
. . relatedEntry . billingSummary Σ 0..* 0..1 BackboneElement string An item that Billing summary in the context of this catalog entry is related to
. . . relationtype scheduleSummary 1..1 0..1 code string triggers | is-replaced-by CatalogEntryRelationType ( Required ) Schedule summary for the catalog entry
. . item . limitationSummary 1..1 0..1 Reference ( CatalogEntry string ) The reference to Summary of limitations for the related item catalog entry
... regulatorySummary 0..1 string Regulatory summary for the catalog entry

doco Documentation for this format

UML Diagram ( Legend )

CatalogEntry ( DomainResource ) Used in supporting different identifiers for Business identifier uniquely assigned to the same product, e.g. manufacturer code and retailer code catalog entry identifier : Identifier [0..*] The type name of this catalog entry announces the item - medication, device, service, protocol that is represented by the entry name : string [0..1] The type of resource that is represented by this catalog entry type : code [0..1] « Types of resources that can be attached to catalog entries. (Strength=Required) CatalogEntryType ! » Indicates whether this catalog entry is open to public usage (active) or not (draft or retired) (this element modifies the meaning of other elements) type status : CodeableConcept code [0..1] « Public usability statuses for catalog entries. (Strength=Required) CatalogEntryStatus ! » Whether Period of usability of the catalog entry effectivePeriod : Period [0..1] Indicates whether or not the entry represents an orderable item that is orderable (this element modifies the meaning of other elements) orderable : boolean [1..1] The item in a (resource) that this entry of the catalog or definition represents referencedItem : Reference [1..1] « Medication | Device DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary MedicationKnowledge | Substance | Location » Used in supporting related concepts, e.g. NDC to RxNorm Last actor who recorded (created or updated) this catalog entry additionalIdentifier updatedBy : Identifier Reference [0..*] [0..1] « Person | Device » Classes of devices, or ATC for medication Notes and comments about this catalog entry classification note : CodeableConcept Annotation [0..*] Used to support catalog exchange even for unsupported products, e.g. getting list Estimated duration of medications even if not prescribable the orderable item of this entry of the catalog status estimatedDuration : code Duration [0..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » The time period Billing code associated to the item in which the context of this catalog entry is expected to be active of the catalog validityPeriod billingCode : Period CodeableConcept [0..1] [0..*] « Billing codes for entries of catalogs of orderable items. (Strength=Example) All CPT ?? » The date until which Billing summary attached to the item in the context of this catalog entry is expected to be active of the catalog validTo billingSummary : dateTime string [0..1] Typically date of issue is different from Schedule summary for the beginning item in the context of this entry of the validity. This can be used to see when an item was last updated catalog lastUpdated scheduleSummary : dateTime string [0..1] Used Summary of limitations for examplefor Out the item in the context of Formulary, or any specifics this entry of the catalog additionalCharacteristic limitationSummary : CodeableConcept string [0..*] [0..1] User for example Regulatory summary for ATC classification, or the item in the context of this entry of the catalog additionalClassification regulatorySummary : CodeableConcept string [0..*] [0..1] RelatedEntry The type of relation relationship to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc entry relationtype relationship : code [1..1] « The type Types of relations relationships between entries. (Strength=Required) CatalogEntryRelationType ! » The reference to the related item entry item target : Reference [1..1] « CatalogEntry » Used for example, to point to a substance, or to a device used to administer a medication relatedEntry [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>
 <</type>
 <
 <|
   |
   </referencedItem>
 <</additionalIdentifier>
 <</classification>
 <
 <</validityPeriod>
 <
 <
 <</additionalCharacteristic>
 <</additionalClassification>
 <
  <
  <</item>

 <identifier><!-- 0..* Identifier Business identifier of the catalog entry --></identifier>
 <name value="[string]"/><!-- 0..1 Displayable name assigned to the catalog entry -->
 <type value="[code]"/><!-- 0..1 ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location -->
 <status value="[code]"/><!-- 0..1 draft | active | retired -->
 <effectivePeriod><!-- 0..1 Period When this catalog entry is expected to be active --></effectivePeriod>
 <orderable value="[boolean]"/><!-- 1..1 Is orderable -->
 <referencedItem><!-- 1..1 Reference(ActivityDefinition|DeviceDefinition|
   HealthcareService|Location|MedicationKnowledge|ObservationDefinition|
   Organization|PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition|
   Substance) Item attached to this entry of the catalog --></referencedItem>

 <relatedEntry>  <!-- 0..* Another entry of the catalog related to this one -->
  <relationship value="[code]"/><!-- 1..1 triggers | is-replaced-by | excludes | includes -->
  <target><!-- 1..1 Reference(CatalogEntry) The reference to the related entry --></target>

 </relatedEntry>
 <updatedBy><!-- 0..1 Reference(Device|Person) Last updater of this catalog entry --></updatedBy>
 <note><!-- 0..* Annotation Notes and comments about this catalog entry --></note>
 <estimatedDuration><!-- 0..1 Duration Estimated duration of the orderable item --></estimatedDuration>
 <billingCode><!-- 0..* CodeableConcept Billing code in the context of this catalog entry --></billingCode>
 <billingSummary value="[string]"/><!-- 0..1 Billing summary in the context of this catalog entry -->
 <scheduleSummary value="[string]"/><!-- 0..1 Schedule summary for the catalog entry -->
 <limitationSummary value="[string]"/><!-- 0..1 Summary of limitations for the catalog entry -->
 <regulatorySummary value="[string]"/><!-- 0..1 Regulatory  summary for the catalog entry -->

</CatalogEntry>

JSON Template 

{doco
  "resourceType" : "CatalogEntry",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "|
   |
   
  "
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
  }]

  "identifier" : [{ Identifier }], // Business identifier of the catalog entry
  "name" : "<string>", // Displayable name assigned to the catalog entry
  "type" : "<code>", // ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
  "status" : "<code>", // draft | active | retired
  "effectivePeriod" : { Period }, // When this catalog entry is expected to be active
  "orderable" : <boolean>, // R!  Is orderable
  "referencedItem" : { Reference(ActivityDefinition|DeviceDefinition|
   HealthcareService|Location|MedicationKnowledge|ObservationDefinition|
   Organization|PlanDefinition|Practitioner|PractitionerRole|SpecimenDefinition|
   Substance) }, // R!  Item attached to this entry of the catalog

  "relatedEntry" : [{ // Another entry of the catalog related to this one
    "relationship" : "<code>", // R!  triggers | is-replaced-by | excludes | includes
    "target" : { Reference(CatalogEntry) } // R!  The reference to the related entry
  }],
  "updatedBy" : { Reference(Device|Person) }, // Last updater of this catalog entry
  "note" : [{ Annotation }], // Notes and comments about this catalog entry
  "estimatedDuration" : { Duration }, // Estimated duration of the orderable item
  "billingCode" : [{ CodeableConcept }], // Billing code in the context of this catalog entry
  "billingSummary" : "<string>", // Billing summary in the context of this catalog entry
  "scheduleSummary" : "<string>", // Schedule summary for the catalog entry
  "limitationSummary" : "<string>", // Summary of limitations for the catalog entry
  "regulatorySummary" : "<string>" // Regulatory  summary for the catalog entry

}

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:
  fhir:
  fhir:
  fhir:|
  |
  
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:

  fhir:CatalogEntry.identifier [ Identifier ], ... ; # 0..* Business identifier of the catalog entry
  fhir:CatalogEntry.name [ string ]; # 0..1 Displayable name assigned to the catalog entry
  fhir:CatalogEntry.type [ code ]; # 0..1 ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
  fhir:CatalogEntry.status [ code ]; # 0..1 draft | active | retired
  fhir:CatalogEntry.effectivePeriod [ Period ]; # 0..1 When this catalog entry is expected to be active
  fhir:CatalogEntry.orderable [ boolean ]; # 1..1 Is orderable
  fhir:CatalogEntry.referencedItem [ Reference(ActivityDefinition|DeviceDefinition|HealthcareService|Location|
  MedicationKnowledge|ObservationDefinition|Organization|PlanDefinition|
  Practitioner|PractitionerRole|SpecimenDefinition|Substance) ]; # 1..1 Item attached to this entry of the catalog

  fhir:CatalogEntry.relatedEntry [ # 0..* Another entry of the catalog related to this one
    fhir:CatalogEntry.relatedEntry.relationship [ code ]; # 1..1 triggers | is-replaced-by | excludes | includes
    fhir:CatalogEntry.relatedEntry.target [ Reference(CatalogEntry) ]; # 1..1 The reference to the related entry

  ], ...;
  fhir:CatalogEntry.updatedBy [ Reference(Device|Person) ]; # 0..1 Last updater of this catalog entry
  fhir:CatalogEntry.note [ Annotation ], ... ; # 0..* Notes and comments about this catalog entry
  fhir:CatalogEntry.estimatedDuration [ Duration ]; # 0..1 Estimated duration of the orderable item
  fhir:CatalogEntry.billingCode [ CodeableConcept ], ... ; # 0..* Billing code in the context of this catalog entry
  fhir:CatalogEntry.billingSummary [ string ]; # 0..1 Billing summary in the context of this catalog entry
  fhir:CatalogEntry.scheduleSummary [ string ]; # 0..1 Schedule summary for the catalog entry
  fhir:CatalogEntry.limitationSummary [ string ]; # 0..1 Summary of limitations for the catalog entry
  fhir:CatalogEntry.regulatorySummary [ string ]; # 0..1 Regulatory  summary for the catalog entry

]

Changes since Release 3

CatalogEntry
CatalogEntry.name
  • Added Element
CatalogEntry.type
  • Type changed from CodeableConcept to code
  • Add Binding http://hl7.org/fhir/ValueSet/catalogentry-type|4.2.0 (required)
CatalogEntry.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/catalogentry-status|4.2.0
  • Now marked as Modifier
CatalogEntry.effectivePeriod
  • Added Element
CatalogEntry.orderable
  • Now marked as Modifier
CatalogEntry.referencedItem
  • Type Reference: Added Target Types DeviceDefinition, MedicationKnowledge, Substance, Location
  • Type Reference: Removed Target Types Medication, Device, Binary
CatalogEntry.relatedEntry.relationship
  • Added Mandatory Element
CatalogEntry.relatedEntry.target
  • Added Mandatory Element
CatalogEntry.updatedBy
  • Added Element
CatalogEntry.note
  • Added Element
CatalogEntry.estimatedDuration
  • Added Element
CatalogEntry.billingCode
  • Added Element
CatalogEntry.billingSummary
  • Added Element
CatalogEntry.scheduleSummary
  • Added Element
CatalogEntry.limitationSummary
  • Added Element
CatalogEntry.regulatorySummary
  • Added Element
CatalogEntry.additionalIdentifier
  • deleted
CatalogEntry.classification
  • deleted
CatalogEntry.validityPeriod
  • deleted
CatalogEntry.validTo
  • deleted
CatalogEntry.lastUpdated
  • deleted
CatalogEntry.additionalCharacteristic
  • deleted
CatalogEntry.additionalClassification
  • deleted
CatalogEntry.relatedEntry.relationtype
  • deleted
CatalogEntry.relatedEntry.item
  • deleted

This resource did not exist in Release 2 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 spreadsheet version & the dependency analysis a

8.28.3.1 8.28.4.1 Terminology Bindings

CatalogEntry.status
Path Definition Type Reference
CatalogEntry.type The lifecycle status Types of an artifact. resources that can be attached to catalog entries. Required PublicationStatus CatalogEntryType
CatalogEntry.status Public usability statuses for catalog entries. Required CatalogEntryStatus
CatalogEntry.relatedEntry.relationtype CatalogEntry.relatedEntry.relationship The type Types of relations relationships between entries. Required CatalogEntryRelationType
CatalogEntry.billingCode Billing codes for entries of catalogs of orderable items. Example All CPT codes

8.28.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
identifier token Business identifier of the catalog entry CatalogEntry.identifier
name N string Displayable name assigned to the catalog entry CatalogEntry.name
orderable N token Is orderable CatalogEntry.orderable
referenced-item reference Item attached to this entry of the catalog CatalogEntry.referencedItem
( Practitioner , SpecimenDefinition , Organization , DeviceDefinition , ObservationDefinition , MedicationKnowledge , PlanDefinition , Substance , HealthcareService , PractitionerRole , ActivityDefinition , Location )
related-entry reference The reference to the related entry CatalogEntry.relatedEntry.target
( CatalogEntry )
status N token Usability status of this entry in the catalog CatalogEntry.status
type N token ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location CatalogEntry.type