CatalogEntry
Catalog entries are wrappers that contextualize items included in a catalog.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/CatalogEntry/[id] |
| Vread | GET | /fhir/R4/CatalogEntry/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/CatalogEntry/[id] |
| Patch | PATCH | /fhir/R4/CatalogEntry/[id] |
| Delete | DELETE | /fhir/R4/CatalogEntry/[id] |
| Create | POST | /fhir/R4/CatalogEntry |
| Search | GET | /fhir/R4/CatalogEntry |
| History | GET | /fhir/R4/CatalogEntry/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Unique identifier of the catalog item |
type | CodeableConcept | 0..1 | The type of item - medication, device, service, protocol or other |
orderable | boolean | 1..1 | Whether the entry represents an orderable item |
referencedItem | Reference | 1..1 | The item that is being defined |
additionalIdentifier | Identifier | 0..* | Any additional identifier(s) for the catalog item, in the same granularity or concept |
classification | CodeableConcept | 0..* | Classification (category or class) of the item entry |
status | code | 0..1 | draft | active | retired | unknown |
validityPeriod | Period | 0..1 | The time period in which this catalog entry is expected to be active |
validTo | dateTime | 0..1 | The date until which this catalog entry is expected to be active |
lastUpdated | dateTime | 0..1 | When was this catalog last updated |
additionalCharacteristic | CodeableConcept | 0..* | Additional characteristics of the catalog entry |
additionalClassification | CodeableConcept | 0..* | Additional classification of the catalog entry |
relatedEntry | BackboneElement | 0..* | An item that this catalog entry is related to |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
| — | — | No resource-specific search parameters are listed in the package. |
Reference
Official FHIR R4 spec: CatalogEntry.
Maturity: Draft (FMM 0).