CatalogEntry - FHIR Resource (r4)

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

Validate an CatalogEntry FHIR Resource (r4)

CatalogEntry Attributes

AttributeField is listTypeDescription

Description: Unique identifier of the catalog item

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://example.com/identifier",
    "value": "123"
  }
]

Learn more about the (CatalogEntry) identifier FHIR attribute

Description: The type of item - medication, device, service, protocol or other

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": {
  "text": "Medication"
}

Learn more about the (CatalogEntry) type FHIR attribute

Description: Whether the entry represents an orderable item

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"orderable": true

Learn more about the (CatalogEntry) orderable FHIR attribute

Description: "referencedItem" : { Reference(Medication|Device|Organization|Practitioner|

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"referencedItem": {
  "reference": "Medication/123"
}

Learn more about the (CatalogEntry) referencedItem FHIR attribute

Description: Any additional identifier(s) for the catalog item, in the same granularity or concept

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"additionalIdentifier":

Learn more about the (CatalogEntry) additionalIdentifier FHIR attribute

Description: Classification (category or class) of the item entry

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"classification":

Learn more about the (CatalogEntry) classification FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status":

Learn more about the (CatalogEntry) status FHIR attribute

Description: The time period in which this catalog entry is expected to be active

FHIR Version: r4

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"validityPeriod":

Learn more about the (CatalogEntry) validityPeriod FHIR attribute

Description: The date until which this catalog entry is expected to be active

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"validTo":

Learn more about the (CatalogEntry) validTo FHIR attribute

Description: When was this catalog last updated

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"lastUpdated":

Learn more about the (CatalogEntry) lastUpdated FHIR attribute

Description: Additional characteristics of the catalog entry

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"additionalCharacteristic":

Learn more about the (CatalogEntry) additionalCharacteristic FHIR attribute

Description: Additional classification of the catalog entry

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"additionalClassification":

Learn more about the (CatalogEntry) additionalClassification FHIR attribute

Description: An item that this catalog entry is related to

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"relatedEntry":

Learn more about the (CatalogEntry) relatedEntry FHIR attribute

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 Parameter	Field Type	Resource Fields Searched