R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #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 8.31 Resource EntryDefinition - Content

Orders and Observations Work Group Maturity Level : 0   Draft Trial Use Compartments : Not linked to any defined compartments

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

8.30.1 8.31.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 8.31.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....

8.31.2.1 When to use this resource:

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.

This resource is referenced by itself

8.30.3 8.31.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . EntryDefinition Σ D TU DomainResource An entry in a catalog
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . type identifier Σ 0..* Identifier Unique identifier of the catalog item
... type 0..1 CodeableConcept The type of item - medication, device, service, protocol or other
. . purpose . orderable Σ 1..1 CodeableConcept boolean Whether the entry represents an orderable item, or other item
. . . 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 that is being defined
. . . 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 code The status of the item, e.g. active, approved, deleted… draft | active | retired | unknown
PublicationStatus ( Required )
. . . 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 code The type of relation to the related item has-input | has-output | uses | triggers | is-replaced-by
EntryDefinitionRelationType ( Required )
. . . . item Σ 1..1 Reference ( 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 code identifier : Identifier [0..*] The type of item - medication, device, service, protocol or other type : CodeableConcept [0..1] Whether the entry represents an orderable item, or other item purpose orderable : CodeableConcept boolean [1..1] Content of the The item in a catalog or definition referencedItem : Reference [1..1] « Medication | Device | Organization | Practitioner | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary » Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code identifier : Identifier [0..1] Used in supporting related concepts, e.g. NDC to RxNorm additionalIdentifier : Identifier [0..*] Classes of devices, or ATC for medication classification : CodeableConcept [0..*] Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable status : CodeableConcept code [0..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » The time period in which this catalog entry is expected to be active validityPeriod : 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 updated lastUpdated : dateTime [0..1] Used for examplefor Out of Formulary, or any specifics additionalCharacteristic : CodeableConcept [0..*] User for example for ATC classification, or additionalClassification : CodeableConcept [0..*] RelatedEntry The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc relationtype : CodeableConcept code [1..1] « The type of relations between entries. (Strength=Required) EntryDefinitionRelationType ! » The reference to the related item item : Reference [1..1] « EntryDefinition » Used for example, to point to a substance, or to a device used to administer a medication relatedEntry [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>
 <</purpose>
 <|

 <orderable value="[boolean]"/><!-- 1..1 Whether the entry represents an orderable item -->
 <referencedItem><!-- 1..1 Reference(Medication|Device|Organization|Practitioner|

   HealthcareService|ActivityDefinition|PlanDefinition|SpecimenDefinition|
   </referencedItem>
 <</identifier>

   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>

 <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>

  <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:
  fhir:|
  
  fhir:

  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:

  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:

    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 .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

Structure

Name Flags Card. Type Description & Constraints doco
. . EntryDefinition Σ D TU DomainResource An entry in a catalog
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . type identifier Σ 0..* Identifier Unique identifier of the catalog item
... type 0..1 CodeableConcept The type of item - medication, device, service, protocol or other
. . purpose . orderable Σ 1..1 CodeableConcept boolean Whether the entry represents an orderable item, or other item
. . . 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 that is being defined
. . . 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 code The status of the item, e.g. active, approved, deleted… draft | active | retired | unknown
PublicationStatus ( Required )
. . . 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 code The type of relation to the related item has-input | has-output | uses | triggers | is-replaced-by
EntryDefinitionRelationType ( Required )
. . . . item Σ 1..1 Reference ( 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 code identifier : Identifier [0..*] The type of item - medication, device, service, protocol or other type : CodeableConcept [0..1] Whether the entry represents an orderable item, or other item purpose orderable : CodeableConcept boolean [1..1] Content of the The item in a catalog or definition referencedItem : Reference [1..1] « Medication | Device | Organization | Practitioner | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary » Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code identifier : Identifier [0..1] Used in supporting related concepts, e.g. NDC to RxNorm additionalIdentifier : Identifier [0..*] Classes of devices, or ATC for medication classification : CodeableConcept [0..*] Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable status : CodeableConcept code [0..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » The time period in which this catalog entry is expected to be active validityPeriod : 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 updated lastUpdated : dateTime [0..1] Used for examplefor Out of Formulary, or any specifics additionalCharacteristic : CodeableConcept [0..*] User for example for ATC classification, or additionalClassification : CodeableConcept [0..*] RelatedEntry The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc relationtype : CodeableConcept code [1..1] « The type of relations between entries. (Strength=Required) EntryDefinitionRelationType ! » The reference to the related item item : Reference [1..1] « EntryDefinition » Used for example, to point to a substance, or to a device used to administer a medication relatedEntry [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>
 <</purpose>
 <|

 <orderable value="[boolean]"/><!-- 1..1 Whether the entry represents an orderable item -->
 <referencedItem><!-- 1..1 Reference(Medication|Device|Organization|Practitioner|

   HealthcareService|ActivityDefinition|PlanDefinition|SpecimenDefinition|
   </referencedItem>
 <</identifier>

   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>

 <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>

  <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:
  fhir:|
  
  fhir:

  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:

  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:

    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 Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

 

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

8.31.3.1 Terminology Bindings

Path Definition Type Reference
EntryDefinition.status The lifecycle status of an artifact. Required PublicationStatus
EntryDefinition.relatedEntry.relationtype The type of relations between entries. Required EntryDefinitionRelationType