Current Build

8.31 Resource EntryDefinition - Content

Orders and Observations Work GroupMaturity Level: 0 Draft Compartments: Not linked to any defined compartments

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

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.

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

This resource can be used to enhance the definition of products or other items. When the product is defined on its own, the corresponding resource can be used and EntryDefinition is not needed. When defining a product (or item) in a specific context or adding characteristics that are outside the intrinsic definition of the product, the EntryDefinition can be used. For example, when defining a lab procedure that uses some types of specimen or some types of devices, in a given context (e.g. where the specimen definition changes according to the procedure), the entryDefinition allows defining the item and relationships for each context, without requiring to define entirely different different specimen, one for each context.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryDefinition DDomainResourceAn entry in a catalog
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierUnique identifier of the catalog item
... type 0..1CodeableConceptThe type of item - medication, device, service, protocol or other
... orderable Σ1..1booleanWhether the entry represents an orderable item
... referencedItem Σ1..1Reference(Medication | Device | Organization | Practitioner | 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 | unknown
PublicationStatus (Required)
... validityPeriod 0..1PeriodThe time period in 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
.... relationtype 1..1codehas-input | has-output | uses | triggers | is-replaced-by
EntryDefinitionRelationType (Required)
.... item 1..1Reference(EntryDefinition)The reference to the related item

doco Documentation for this format

UML Diagram (Legend)

EntryDefinition (DomainResource)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer codeidentifier : Identifier [0..*]The type of item - medication, device, service, protocol or othertype : CodeableConcept [0..1]Whether the entry represents an orderable itemorderable : boolean [1..1]The item in a catalog or definitionreferencedItem : Reference [1..1] « Medication|Device|Organization| Practitioner|HealthcareService|ActivityDefinition| PlanDefinition|SpecimenDefinition|ObservationDefinition|Binary »Used in supporting related concepts, e.g. NDC to RxNormadditionalIdentifier : Identifier [0..*]Classes of devices, or ATC for medicationclassification : CodeableConcept [0..*]Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribablestatus : code [0..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The time period in which this catalog entry is expected to be activevalidityPeriod : Period [0..1]Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updatedlastUpdated : dateTime [0..1]Used for examplefor Out of Formulary, or any specificsadditionalCharacteristic : CodeableConcept [0..*]User for example for ATC classification, oradditionalClassification : CodeableConcept [0..*]RelatedEntryThe type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etcrelationtype : code [1..1] « The type of relations between entries (Strength=Required)EntryDefinitionRelationType! »The reference to the related itemitem : Reference [1..1] « EntryDefinition »Used for example, to point to a substance, or to a device used to administer a medicationrelatedEntry[0..*]

XML Template

<EntryDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier of the catalog item --></identifier>
 <type><!-- 0..1 CodeableConcept The type of item - medication, device, service, protocol or other --></type>
 <orderable value="[boolean]"/><!-- 1..1 Whether the entry represents an orderable item -->
 <referencedItem><!-- 1..1 Reference(Medication|Device|Organization|Practitioner|
   HealthcareService|ActivityDefinition|PlanDefinition|SpecimenDefinition|
   ObservationDefinition|Binary) The item that is being defined --></referencedItem>
 <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 value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <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 value="[code]"/><!-- 1..1 has-input | has-output | uses | triggers | is-replaced-by -->
  <item><!-- 1..1 Reference(EntryDefinition) The reference to the related item --></item>
 </relatedEntry>
</EntryDefinition>

JSON Template

{doco
  "resourceType" : "EntryDefinition",
  // 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|
   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
  "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!  has-input | has-output | uses | triggers | is-replaced-by
    "item" : { Reference(EntryDefinition) } // R!  The reference to the related item
  }]
}

Turtle Template

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


[ 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.identifier [ Identifier ], ... ; # 0..* Unique identifier of the catalog item
  fhir:EntryDefinition.type [ CodeableConcept ]; # 0..1 The type of item - medication, device, service, protocol or other
  fhir:EntryDefinition.orderable [ boolean ]; # 1..1 Whether the entry represents an orderable item
  fhir:EntryDefinition.referencedItem [ Reference(Medication|Device|Organization|Practitioner|HealthcareService|ActivityDefinition|
  PlanDefinition|SpecimenDefinition|ObservationDefinition|Binary) ]; # 1..1 The item that is being defined
  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 [ code ]; # 0..1 draft | active | retired | unknown
  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 [ code ]; # 1..1 has-input | has-output | uses | triggers | is-replaced-by
    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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryDefinition DDomainResourceAn entry in a catalog
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierUnique identifier of the catalog item
... type 0..1CodeableConceptThe type of item - medication, device, service, protocol or other
... orderable Σ1..1booleanWhether the entry represents an orderable item
... referencedItem Σ1..1Reference(Medication | Device | Organization | Practitioner | 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 | unknown
PublicationStatus (Required)
... validityPeriod 0..1PeriodThe time period in 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
.... relationtype 1..1codehas-input | has-output | uses | triggers | is-replaced-by
EntryDefinitionRelationType (Required)
.... item 1..1Reference(EntryDefinition)The reference to the related item

doco Documentation for this format

UML Diagram (Legend)

EntryDefinition (DomainResource)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer codeidentifier : Identifier [0..*]The type of item - medication, device, service, protocol or othertype : CodeableConcept [0..1]Whether the entry represents an orderable itemorderable : boolean [1..1]The item in a catalog or definitionreferencedItem : Reference [1..1] « Medication|Device|Organization| Practitioner|HealthcareService|ActivityDefinition| PlanDefinition|SpecimenDefinition|ObservationDefinition|Binary »Used in supporting related concepts, e.g. NDC to RxNormadditionalIdentifier : Identifier [0..*]Classes of devices, or ATC for medicationclassification : CodeableConcept [0..*]Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribablestatus : code [0..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The time period in which this catalog entry is expected to be activevalidityPeriod : Period [0..1]Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updatedlastUpdated : dateTime [0..1]Used for examplefor Out of Formulary, or any specificsadditionalCharacteristic : CodeableConcept [0..*]User for example for ATC classification, oradditionalClassification : CodeableConcept [0..*]RelatedEntryThe type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etcrelationtype : code [1..1] « The type of relations between entries (Strength=Required)EntryDefinitionRelationType! »The reference to the related itemitem : Reference [1..1] « EntryDefinition »Used for example, to point to a substance, or to a device used to administer a medicationrelatedEntry[0..*]

XML Template

<EntryDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier of the catalog item --></identifier>
 <type><!-- 0..1 CodeableConcept The type of item - medication, device, service, protocol or other --></type>
 <orderable value="[boolean]"/><!-- 1..1 Whether the entry represents an orderable item -->
 <referencedItem><!-- 1..1 Reference(Medication|Device|Organization|Practitioner|
   HealthcareService|ActivityDefinition|PlanDefinition|SpecimenDefinition|
   ObservationDefinition|Binary) The item that is being defined --></referencedItem>
 <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 value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <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 value="[code]"/><!-- 1..1 has-input | has-output | uses | triggers | is-replaced-by -->
  <item><!-- 1..1 Reference(EntryDefinition) The reference to the related item --></item>
 </relatedEntry>
</EntryDefinition>

JSON Template

{doco
  "resourceType" : "EntryDefinition",
  // 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|
   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
  "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!  has-input | has-output | uses | triggers | is-replaced-by
    "item" : { Reference(EntryDefinition) } // R!  The reference to the related item
  }]
}

Turtle Template

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


[ 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.identifier [ Identifier ], ... ; # 0..* Unique identifier of the catalog item
  fhir:EntryDefinition.type [ CodeableConcept ]; # 0..1 The type of item - medication, device, service, protocol or other
  fhir:EntryDefinition.orderable [ boolean ]; # 1..1 Whether the entry represents an orderable item
  fhir:EntryDefinition.referencedItem [ Reference(Medication|Device|Organization|Practitioner|HealthcareService|ActivityDefinition|
  PlanDefinition|SpecimenDefinition|ObservationDefinition|Binary) ]; # 1..1 The item that is being defined
  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 [ code ]; # 0..1 draft | active | retired | unknown
  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 [ code ]; # 1..1 has-input | has-output | uses | triggers | is-replaced-by
    fhir:EntryDefinition.relatedEntry.item [ Reference(EntryDefinition) ]; # 1..1 The reference to the related item
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

PathDefinitionTypeReference
EntryDefinition.status The lifecycle status of an artifact.RequiredPublicationStatus
EntryDefinition.relatedEntry.relationtype The type of relations between entriesRequiredEntryDefinitionRelationType