Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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 allows to organize resources representing the definition of {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 pharmacy formulary
  • a laboratory procedures compendium
  • a radiology procedures compendium
  • a dietary nutrition order catalog
  • a supply charge master
  • 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

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 contains nestable sections, each of which contains a number of entry elements referencing CatalogEntry resources.

Thus, a CatalogEntry resource represents an entry of a Catalog. It acts as a wrapper that contextualizes the inclusion into the catalog of an item (product, service, artifact, location ...) directly orderable/selectable by catalog consumers.

The CatalogEntry specifies the period of usability of the item by consumers of the catalog. It holds the current status of the item in the catalog as well as its orderability, the charges, limitations, constraints and regulations associated with the item in the context of this catalog. CatalogEntry facilitates the maintenance of the catalog over time, enabling to retire entries and to replace them by others, tracking who updates them.

8.28.2 Boundaries and Relationships

CatalogEntry 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 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 in the context of this catalog. Catalog entries can also be related to one another. Only relationships that hold within the context of a catalog and not generally for the items referenced by the catalog entries are supported this way. For instance, in the context of a given laboratory service compendium, a laboratory orderable service may be preferred over other laboratory services. The other laboratory services in this use case may thus be related to the preferred service using an 'is-replaced-by' relationship and assigned a new status of 'retired'. 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, reside at the level of the definitional resource itself. That is, laboratory orderable procedures often state the required input observation specifications, the format of the expected observation output, and the attributes of the required specimens. These kind of relationships are 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.

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..*IdentifierBusiness identifier of the catalog entry
... name Σ0..1stringDisplayable name assigned to the catalog entry
... type Σ0..1codeActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
CatalogEntryType (Required)
... effectivePeriod 0..1PeriodWhen this catalog entry is expected to be active
... orderable ?!Σ1..1booleanIs orderable
... referencedItem Σ1..1Reference(DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | MedicationKnowledge | Substance | Location)Item attached to this entry of the catalog
... relatedEntry 0..*BackboneElementAnother entry of the catalog related to this one
.... relationship 1..1codetriggers | is-replaced-by | excludes | includes
CatalogEntryRelationType (Required)
.... target 1..1Reference(CatalogEntry)The reference to the related entry
... updatedBy 0..1Reference(Person | Device)Last updater of this catalog entry
... note 0..*AnnotationNotes and comments about this catalog entry
... estimatedDuration 0..1DurationEstimated duration of the orderable item
... billingCode Σ0..*CodeableConceptBilling code in the context of this catalog entry
All CPT codes (Example)
... billingSummary Σ0..1stringBilling summary in the context of this catalog entry
... scheduleSummary 0..1stringSchedule summary for the catalog entry
... limitationSummary 0..1stringSummary of limitations for the catalog entry
... regulatorySummary 0..1stringRegulatory summary for the catalog entry

doco Documentation for this format

UML Diagram (Legend)

CatalogEntry (DomainResource)Business identifier uniquely assigned to the catalog entryidentifier : Identifier [0..*]The name of this catalog entry announces the item that is represented by the entryname : string [0..1]The type of resource that is represented by this catalog entrytype : code [0..1] « null (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)status : code [0..1] « null (Strength=Required)CatalogEntryStatus! »Period of usability of the catalog entryeffectivePeriod : Period [0..1]Indicates whether or not the entry represents an item that is orderable (this element modifies the meaning of other elements)orderable : boolean [1..1]The item (resource) that this entry of the catalog representsreferencedItem : Reference [1..1] « DeviceDefinition|Organization| Practitioner|PractitionerRole|HealthcareService| ActivityDefinition|PlanDefinition|SpecimenDefinition| ObservationDefinition|MedicationKnowledge|Substance|Location »Last actor who recorded (created or updated) this catalog entryupdatedBy : Reference [0..1] « Person|Device »Notes and comments about this catalog entrynote : Annotation [0..*]Estimated duration of the orderable item of this entry of the catalogestimatedDuration : Duration [0..1]Billing code associated to the item in the context of this entry of the catalogbillingCode : CodeableConcept [0..*] « null (Strength=Example)All CPT ?? »Billing summary attached to the item in the context of this entry of the catalogbillingSummary : string [0..1]Schedule summary for the item in the context of this entry of the catalogscheduleSummary : string [0..1]Summary of limitations for the item in the context of this entry of the cataloglimitationSummary : string [0..1]Regulatory summary for the item in the context of this entry of the catalogregulatorySummary : string [0..1]RelatedEntryThe type of relationship to the related entryrelationship : code [1..1] « null (Strength=Required)CatalogEntryRelationType! »The reference to the related entrytarget : 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 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: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.6.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.6.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

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..*IdentifierBusiness identifier of the catalog entry
... name Σ0..1stringDisplayable name assigned to the catalog entry
... type Σ0..1codeActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location
CatalogEntryType (Required)
... effectivePeriod 0..1PeriodWhen this catalog entry is expected to be active
... orderable ?!Σ1..1booleanIs orderable
... referencedItem Σ1..1Reference(DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | MedicationKnowledge | Substance | Location)Item attached to this entry of the catalog
... relatedEntry 0..*BackboneElementAnother entry of the catalog related to this one
.... relationship 1..1codetriggers | is-replaced-by | excludes | includes
CatalogEntryRelationType (Required)
.... target 1..1Reference(CatalogEntry)The reference to the related entry
... updatedBy 0..1Reference(Person | Device)Last updater of this catalog entry
... note 0..*AnnotationNotes and comments about this catalog entry
... estimatedDuration 0..1DurationEstimated duration of the orderable item
... billingCode Σ0..*CodeableConceptBilling code in the context of this catalog entry
All CPT codes (Example)
... billingSummary Σ0..1stringBilling summary in the context of this catalog entry
... scheduleSummary 0..1stringSchedule summary for the catalog entry
... limitationSummary 0..1stringSummary of limitations for the catalog entry
... regulatorySummary 0..1stringRegulatory summary for the catalog entry

doco Documentation for this format

UML Diagram (Legend)

CatalogEntry (DomainResource)Business identifier uniquely assigned to the catalog entryidentifier : Identifier [0..*]The name of this catalog entry announces the item that is represented by the entryname : string [0..1]The type of resource that is represented by this catalog entrytype : code [0..1] « null (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)status : code [0..1] « null (Strength=Required)CatalogEntryStatus! »Period of usability of the catalog entryeffectivePeriod : Period [0..1]Indicates whether or not the entry represents an item that is orderable (this element modifies the meaning of other elements)orderable : boolean [1..1]The item (resource) that this entry of the catalog representsreferencedItem : Reference [1..1] « DeviceDefinition|Organization| Practitioner|PractitionerRole|HealthcareService| ActivityDefinition|PlanDefinition|SpecimenDefinition| ObservationDefinition|MedicationKnowledge|Substance|Location »Last actor who recorded (created or updated) this catalog entryupdatedBy : Reference [0..1] « Person|Device »Notes and comments about this catalog entrynote : Annotation [0..*]Estimated duration of the orderable item of this entry of the catalogestimatedDuration : Duration [0..1]Billing code associated to the item in the context of this entry of the catalogbillingCode : CodeableConcept [0..*] « null (Strength=Example)All CPT ?? »Billing summary attached to the item in the context of this entry of the catalogbillingSummary : string [0..1]Schedule summary for the item in the context of this entry of the catalogscheduleSummary : string [0..1]Summary of limitations for the item in the context of this entry of the cataloglimitationSummary : string [0..1]Regulatory summary for the item in the context of this entry of the catalogregulatorySummary : string [0..1]RelatedEntryThe type of relationship to the related entryrelationship : code [1..1] « null (Strength=Required)CatalogEntryRelationType! »The reference to the related entrytarget : 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 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: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.6.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.6.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

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.4.1 Terminology Bindings

PathDefinitionTypeReference
CatalogEntry.type RequiredCatalogEntryType
CatalogEntry.status RequiredCatalogEntryStatus
CatalogEntry.relatedEntry.relationship RequiredCatalogEntryRelationType
CatalogEntry.billingCode ExampleAll 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.

NameTypeDescriptionExpressionIn Common
identifiertokenBusiness identifier of the catalog entryCatalogEntry.identifier
name NstringDisplayable name assigned to the catalog entryCatalogEntry.name
orderable NtokenIs orderableCatalogEntry.orderable
referenced-itemreferenceItem attached to this entry of the catalogCatalogEntry.referencedItem
(Practitioner, SpecimenDefinition, Organization, DeviceDefinition, ObservationDefinition, MedicationKnowledge, PlanDefinition, Substance, HealthcareService, PractitionerRole, ActivityDefinition, Location)
related-entryreferenceThe reference to the related entryCatalogEntry.relatedEntry.target
(CatalogEntry)
status NtokenUsability status of this entry in the catalogCatalogEntry.status
type NtokenActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | LocationCatalogEntry.type