Release 5 Draft Ballot
AdministrationThis 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
| Orders and Observations Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the CatalogEntry resource.
| CatalogEntry | |
| Element Id | CatalogEntry |
| Definition | Catalog entries are wrappers that contextualize items included in a catalog. |
| Cardinality | 0..* |
| Type | DomainResource |
| Summary | false |
| CatalogEntry.identifier | |
| Element Id | CatalogEntry.identifier |
| Definition | Business identifier uniquely assigned to the catalog entry. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Cardinality | 0..* |
| Type | Identifier |
| Summary | true |
| CatalogEntry.name | |
| Element Id | CatalogEntry.name |
| Definition | The name of this catalog entry announces the item that is represented by the entry. |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| CatalogEntry.type | |
| Element Id | CatalogEntry.type |
| Definition | The type of resource that is represented by this catalog entry. |
| Cardinality | 0..1 |
| Terminology Binding | CatalogEntryType (Required) |
| Type | code |
| Summary | true |
| CatalogEntry.status | |
| Element Id | CatalogEntry.status |
| Definition | Indicates whether this catalog entry is open to public usage (active) or not (draft or retired). |
| Cardinality | 0..1 |
| Terminology Binding | CatalogEntryStatus (Required) |
| Type | code |
| Is Modifier | true (Reason: Not known why this is labelled a modifier) |
| Summary | true |
| CatalogEntry.effectivePeriod | |
| Element Id | CatalogEntry.effectivePeriod |
| Definition | Period of usability of the catalog entry. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | false |
| CatalogEntry.orderable | |
| Element Id | CatalogEntry.orderable |
| Definition | Indicates whether or not the entry represents an item that is orderable. |
| Cardinality | 1..1 |
| Type | boolean |
| Is Modifier | true (Reason: Not known why this is labelled a modifier) |
| Summary | true |
| CatalogEntry.referencedItem | |
| Element Id | CatalogEntry.referencedItem |
| Definition | The item (resource) that this entry of the catalog represents. |
| Cardinality | 1..1 |
| Type | Reference(DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | MedicationKnowledge | Substance | Location) |
| Patterns | Reference(DeviceDefinition,Organization,Practitioner,PractitionerRole,HealthcareService,ActivityDefinition,PlanDefinition,SpecimenDefinition,ObservationDefinition,MedicationKnowledge,Substance,Location): No common pattern |
| Summary | true |
| CatalogEntry.relatedEntry | |
| Element Id | CatalogEntry.relatedEntry |
| Definition | Used for example, to point to a substance, or to a device used to administer a medication. |
| Cardinality | 0..* |
| Summary | false |
| CatalogEntry.relatedEntry.relationship | |
| Element Id | CatalogEntry.relatedEntry.relationship |
| Definition | The type of relationship to the related entry. |
| Cardinality | 1..1 |
| Terminology Binding | CatalogEntryRelationType (Required) |
| Type | code |
| Summary | false |
| CatalogEntry.relatedEntry.target | |
| Element Id | CatalogEntry.relatedEntry.target |
| Definition | The reference to the related entry. |
| Cardinality | 1..1 |
| Type | Reference(CatalogEntry) |
| Summary | false |
| CatalogEntry.updatedBy | |
| Element Id | CatalogEntry.updatedBy |
| Definition | Last actor who recorded (created or updated) this catalog entry. |
| Cardinality | 0..1 |
| Type | Reference(Person | Device) |
| Patterns | Reference(Person,Device): No common pattern |
| Summary | false |
| CatalogEntry.note | |
| Element Id | CatalogEntry.note |
| Definition | Notes and comments about this catalog entry. |
| Cardinality | 0..* |
| Type | Annotation |
| Summary | false |
| CatalogEntry.estimatedDuration | |
| Element Id | CatalogEntry.estimatedDuration |
| Definition | Estimated duration of the orderable item of this entry of the catalog. |
| Cardinality | 0..1 |
| Type | Duration |
| Summary | false |
| CatalogEntry.billingCode | |
| Element Id | CatalogEntry.billingCode |
| Definition | Billing code associated to the item in the context of this entry of the catalog. |
| Cardinality | 0..* |
| Terminology Binding | All CPT codes (Example) |
| Type | CodeableConcept |
| Summary | true |
| CatalogEntry.billingSummary | |
| Element Id | CatalogEntry.billingSummary |
| Definition | Billing summary attached to the item in the context of this entry of the catalog. |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| CatalogEntry.scheduleSummary | |
| Element Id | CatalogEntry.scheduleSummary |
| Definition | Schedule summary for the item in the context of this entry of the catalog. |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| CatalogEntry.limitationSummary | |
| Element Id | CatalogEntry.limitationSummary |
| Definition | Summary of limitations for the item in the context of this entry of the catalog. |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| CatalogEntry.regulatorySummary | |
| Element Id | CatalogEntry.regulatorySummary |
| Definition | Regulatory summary for the item in the context of this entry of the catalog. |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#4.6.0 generated on Thu, Apr 15, 2021 12:28+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change