CatalogEntry - FHIR Resource (r4)


This CatalogEntry Resource uses the FHIR API standard for access and structure.

Validate an CatalogEntry FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
additionalCharacteristictrueCodeableConcept# Additional characteristics of the catalog entry
additionalClassificationtrueCodeableConcept# Additional classification of the catalog entry
additionalIdentifiertrueIdentifier# Any additional identifier(s) for the catalog item, in the same granularity or concept
classificationtrueCodeableConcept# Classification (category or class) of the item entry
identifiertrueIdentifier# Unique identifier of the catalog item
lastUpdatedfalsedateTime# When was this catalog last updated
orderablefalseboolean# Whether the entry represents an orderable item
referencedItemfalseReference# "referencedItem" : { Reference(Medication|Device|Organization|Practitioner|
relatedEntrytrueData Type# An item that this catalog entry is related to
statusfalsecode# draft | active | retired | unknown
typefalseCodeableConcept# The type of item - medication, device, service, protocol or other
validTofalsedateTime# The date until which this catalog entry is expected to be active
validityPeriodfalsePeriod# The time period in which this catalog entry is expected to be active

CatalogEntry Example

{
  "resourceType": "CatalogEntry",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
  },
  "identifier": [
    {
      "system": "http://example.com/identifier",
      "value": "123"
    }
  ],
  "type": {
    "text": "Medication"
  },
  "orderable": true,
  "referencedItem": {
    "reference": "Medication/123"
  }
}

CatalogEntry Structure

{
  "resourceType" : "CatalogEntry",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier of the catalog item
  "type" : { CodeableConcept }, // The type of item - medication, device, service, protocol or other
  "orderable" : <boolean>, // R!  Whether the entry represents an orderable item
  "referencedItem" : { Reference(Medication|Device|Organization|Practitioner|
   PractitionerRole|HealthcareService|ActivityDefinition|PlanDefinition|
   SpecimenDefinition|ObservationDefinition|Binary) }, // R!  The item that is being defined
  "additionalIdentifier" : [{ Identifier }], // Any additional identifier(s) for the catalog item, in the same granularity or concept
  "classification" : [{ CodeableConcept }], // Classification (category or class) of the item entry
  "status" : "<code>", // draft | active | retired | unknown
  "validityPeriod" : { Period }, // The time period in which this catalog entry is expected to be active
  "validTo" : "<dateTime>", // The date until which this catalog entry is expected to be active
  "lastUpdated" : "<dateTime>", // When was this catalog last updated
  "additionalCharacteristic" : [{ CodeableConcept }], // Additional characteristics of the catalog entry
  "additionalClassification" : [{ CodeableConcept }], // Additional classification of the catalog entry
  "relatedEntry" : [{ // An item that this catalog entry is related to
    "relationtype" : "<code>", // R!  triggers | is-replaced-by
    "item" : { Reference(CatalogEntry) } // R!  The reference to the related item
  }]
}

CatalogEntry Search Parameters

The following search parameters can be used to query CatalogEntry resources. Just submit them like so:

https://api.1up.health/fhir/r4/CatalogEntry?query-param=queryvalue
Search ParameterField TypeResource Fields Searched