R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.30 Resource EntryDefinition - Content

Orders and Observations

Work Group

Maturity Level: 0

Draft

Compartments: Not linked to any defined compartments

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

8.30.1 Scope and Usage

Note that this content is preliminary has not undergone proper review by the appropriate Workgroups.

This resource is an administrative resource for using definitional resources in the scope of a catalog. This resource contains additional information about each catalog entry, in the scope of a specific catalog, such as attributes and relations to other entries.

8.30.2 Boundaries and Relationships

This resource is used in a Catalog which is a profile on Composition (link) and contains reference to a definitional resource, such as

The catalog....

Structure

Name	Flags	Card.	Type	Description & Constraints
EntryDefinition	Σ D		DomainResource	An entry in a catalog Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
type	Σ	0..1	CodeableConcept	The type of item - medication, device, service, protocol or other
purpose	Σ	1..1	CodeableConcept	Whether the entry represents an orderable item, or other
referencedItem	Σ	1..1	Reference(Medication \| Device \| Organization \| Practitioner \| HealthcareService \| ActivityDefinition \| PlanDefinition \| SpecimenDefinition \| ObservationDefinition \| Binary)	The item itself
identifier	Σ	0..1	Identifier	Unique identifier of the catalog item
additionalIdentifier	Σ	0..*	Identifier	Any additional identifier(s) for the catalog item, in the same granularity or concept
classification	Σ	0..*	CodeableConcept	Classification (category or class) of the item entry
status	Σ	0..1	CodeableConcept	The status of the item, e.g. active, approved, deleted…
validityPeriod	Σ	0..1	Period	The time period in which this catalog entry is expected to be active
lastUpdated	Σ	0..1	dateTime	When was this catalog last updated
additionalCharacteristic	Σ	0..*	CodeableConcept	Additional characteristics of the catalog entry
additionalClassification	Σ	0..*	CodeableConcept	Additional classification of the catalog entry
relatedEntry	Σ	0..*	BackboneElement	An item that this catalog entry is related to
relationtype	Σ	1..1	CodeableConcept	The type of relation to the related item
item	Σ	1..1	Reference(EntryDefinition)	The reference to the related item
Documentation for this format

UML Diagram (Legend)

XML Template

<EntryDefinition xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <type><!-- 0..1 CodeableConcept The type of item - medication, device, service, protocol or other --></type>
 <purpose><!-- 1..1 CodeableConcept Whether the entry represents an orderable item, or other --></purpose>
 <referencedItem><!-- 1..1 Reference(Medication|Device|Organization|Practitioner|
   HealthcareService|ActivityDefinition|PlanDefinition|SpecimenDefinition|
   ObservationDefinition|Binary) The item itself --></referencedItem>
 <identifier><!-- 0..1 Identifier Unique identifier of the catalog item --></identifier>
 <additionalIdentifier><!-- 0..* Identifier Any additional identifier(s) for the catalog item, in the same granularity or concept --></additionalIdentifier>
 <classification><!-- 0..* CodeableConcept Classification (category or class) of the item entry --></classification>
 <status><!-- 0..1 CodeableConcept The status of the item, e.g. active, approved, deleted… --></status>
 <validityPeriod><!-- 0..1 Period The time period in which this catalog entry is expected to be active --></validityPeriod>
 <lastUpdated value="[dateTime]"/><!-- 0..1 When was this catalog last updated -->
 <additionalCharacteristic><!-- 0..* CodeableConcept Additional characteristics of the catalog entry --></additionalCharacteristic>
 <additionalClassification><!-- 0..* CodeableConcept Additional classification of the catalog entry --></additionalClassification>
 <relatedEntry>  <!-- 0..* An item that this catalog entry is related to -->
  <relationtype><!-- 1..1 CodeableConcept The type of relation to the related item --></relationtype>
  <item><!-- 1..1 Reference(EntryDefinition) The reference to the related item --></item>
 </relatedEntry>
</EntryDefinition>

JSON Template

{
  "resourceType" : "EntryDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "type" : { CodeableConcept }, // The type of item - medication, device, service, protocol or other
  "purpose" : { CodeableConcept }, // R!  Whether the entry represents an orderable item, or other
  "referencedItem" : { Reference(Medication|Device|Organization|Practitioner|
   HealthcareService|ActivityDefinition|PlanDefinition|SpecimenDefinition|
   ObservationDefinition|Binary) }, // R!  The item itself
  "identifier" : { Identifier }, // Unique identifier of the catalog item
  "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" : { CodeableConcept }, // The status of the item, e.g. active, approved, deleted…
  "validityPeriod" : { Period }, // The time period in 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" : { CodeableConcept }, // R!  The type of relation to the related item
    "item" : { Reference(EntryDefinition) } // R!  The reference to the related item
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:EntryDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:EntryDefinition.type [ CodeableConcept ]; # 0..1 The type of item - medication, device, service, protocol or other
  fhir:EntryDefinition.purpose [ CodeableConcept ]; # 1..1 Whether the entry represents an orderable item, or other
  fhir:EntryDefinition.referencedItem [ Reference(Medication|Device|Organization|Practitioner|HealthcareService|ActivityDefinition|
  PlanDefinition|SpecimenDefinition|ObservationDefinition|Binary) ]; # 1..1 The item itself
  fhir:EntryDefinition.identifier [ Identifier ]; # 0..1 Unique identifier of the catalog item
  fhir:EntryDefinition.additionalIdentifier [ Identifier ], ... ; # 0..* Any additional identifier(s) for the catalog item, in the same granularity or concept
  fhir:EntryDefinition.classification [ CodeableConcept ], ... ; # 0..* Classification (category or class) of the item entry
  fhir:EntryDefinition.status [ CodeableConcept ]; # 0..1 The status of the item, e.g. active, approved, deleted…
  fhir:EntryDefinition.validityPeriod [ Period ]; # 0..1 The time period in which this catalog entry is expected to be active
  fhir:EntryDefinition.lastUpdated [ dateTime ]; # 0..1 When was this catalog last updated
  fhir:EntryDefinition.additionalCharacteristic [ CodeableConcept ], ... ; # 0..* Additional characteristics of the catalog entry
  fhir:EntryDefinition.additionalClassification [ CodeableConcept ], ... ; # 0..* Additional classification of the catalog entry
  fhir:EntryDefinition.relatedEntry [ # 0..* An item that this catalog entry is related to
    fhir:EntryDefinition.relatedEntry.relationtype [ CodeableConcept ]; # 1..1 The type of relation to the related item
    fhir:EntryDefinition.relatedEntry.item [ Reference(EntryDefinition) ]; # 1..1 The reference to the related item
  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.