Skip to main content

CatalogEntry

ResourceFoundation · DocumentsTrial useMaturity 0

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

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
0 of 0 parameters tested

Structure​

ElementCard.TypeDescription
identifierΣ
0..*IdentifierUnique identifier of the catalog item
type
0..1CodeableConceptThe type of item - medication, device, service, protocol or other
orderableRequiredΣ
1..1booleanWhether the entry represents an orderable item
referencedItemRequiredΣ
1..1Reference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary)The item that is being defined
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 | unknownBinding (required): publication-status
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
relationtypeRequired
1..1codetriggers | is-replaced-byBinding (required): relation-type
itemRequired
1..1Reference(CatalogEntry)The reference to the related item

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/CatalogEntry?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

CatalogEntry defines no search parameters of its own; the common parameters below apply.

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition