FHIR Cross-Version Extensions package for FHIR R5 from FHIR R4B
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R5 from FHIR R4B - Version 0.0.1-snapshot-2. See the Directory of published versions

Extension: Ext_R4B_CatalogEntry - Detailed Descriptions

Page standards status: Informative Maturity Level: 0

Definitions for the ext-R4B-CatalogEntry extension.

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

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

ShortAn entry in a catalog
Control0..*
2. Extension.extension
Control2..*
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:type
    Slice Nametype
    Definition

    This cross-version extension represents CatalogEntry.type from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortThe type of item - medication, device, service, protocol or other
    Control0..1
    6. Extension.extension:type.url
    Control1..1
    Fixed Valuetype
    8. Extension.extension:type.value[x]
    Definition

    This cross-version extension represents CatalogEntry.type from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortThe type of item - medication, device, service, protocol or other
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    10. Extension.extension:orderable
    Slice Nameorderable
    Definition

    This cross-version extension represents CatalogEntry.orderable from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortWhether the entry represents an orderable item
    Control1..1
    12. Extension.extension:orderable.url
    Control1..1
    Fixed Valueorderable
    14. Extension.extension:orderable.value[x]
    Definition

    This cross-version extension represents CatalogEntry.orderable from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortWhether the entry represents an orderable item
    Typeboolean
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. Extension.extension:referencedItem
    Slice NamereferencedItem
    Definition

    The item in a catalog or definition.

    ShortThe item that is being defined
    Control1..1
    18. Extension.extension:referencedItem.url
    Control1..1
    Fixed ValuereferencedItem
    20. Extension.extension:referencedItem.value[x]
    Definition

    The item in a catalog or definition.

    ShortThe item that is being defined
    TypeReference
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    22. Extension.extension:additionalIdentifier
    Slice NameadditionalIdentifier
    Definition

    Used in supporting related concepts, e.g. NDC to RxNorm.

    ShortAny additional identifier(s) for the catalog item, in the same granularity or concept
    Control0..*
    24. Extension.extension:additionalIdentifier.url
    Control1..1
    Fixed ValueadditionalIdentifier
    26. Extension.extension:additionalIdentifier.value[x]
    Definition

    Used in supporting related concepts, e.g. NDC to RxNorm.

    ShortAny additional identifier(s) for the catalog item, in the same granularity or concept
    TypeIdentifier
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    28. Extension.extension:classification
    Slice Nameclassification
    Definition

    Classes of devices, or ATC for medication.

    ShortClassification (category or class) of the item entry
    Control0..*
    30. Extension.extension:classification.url
    Control1..1
    Fixed Valueclassification
    32. Extension.extension:classification.value[x]
    Definition

    Classes of devices, or ATC for medication.

    ShortClassification (category or class) of the item entry
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    34. Extension.extension:status
    Slice Namestatus
    Definition

    Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

    Shortdraft | active | retired | unknown
    Control0..1
    36. Extension.extension:status.url
    Control1..1
    Fixed Valuestatus
    38. Extension.extension:status.value[x]
    Definition

    Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

    Shortdraft | active | retired | unknown
    BindingThe codes SHALL be taken from R4B_publication_status_for_R5 (0.0.1-snapshot-2)
    (required to http://hl7.org/fhir/4.3/ValueSet/R4B-publication-status-for-R5|0.0.1-snapshot-2)

    The lifecycle status of an artifact.

    Typecode
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    40. Extension.extension:validityPeriod
    Slice NamevalidityPeriod
    Definition

    This cross-version extension represents CatalogEntry.validityPeriod from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortThe time period in which this catalog entry is expected to be active
    Control0..1
    42. Extension.extension:validityPeriod.url
    Control1..1
    Fixed ValuevalidityPeriod
    44. Extension.extension:validityPeriod.value[x]
    Definition

    This cross-version extension represents CatalogEntry.validityPeriod from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortThe time period in which this catalog entry is expected to be active
    TypePeriod
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    46. Extension.extension:validTo
    Slice NamevalidTo
    Definition

    This cross-version extension represents CatalogEntry.validTo from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortThe date until which this catalog entry is expected to be active
    Control0..1
    48. Extension.extension:validTo.url
    Control1..1
    Fixed ValuevalidTo
    50. Extension.extension:validTo.value[x]
    Definition

    This cross-version extension represents CatalogEntry.validTo from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

    ShortThe date until which this catalog entry is expected to be active
    TypedateTime
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    52. Extension.extension:lastUpdated
    Slice NamelastUpdated
    Definition

    Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

    ShortWhen was this catalog last updated
    Control0..1
    54. Extension.extension:lastUpdated.url
    Control1..1
    Fixed ValuelastUpdated
    56. Extension.extension:lastUpdated.value[x]
    Definition

    Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

    ShortWhen was this catalog last updated
    TypedateTime
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    58. Extension.extension:additionalCharacteristic
    Slice NameadditionalCharacteristic
    Definition

    Used for examplefor Out of Formulary, or any specifics.

    ShortAdditional characteristics of the catalog entry
    Control0..*
    60. Extension.extension:additionalCharacteristic.url
    Control1..1
    Fixed ValueadditionalCharacteristic
    62. Extension.extension:additionalCharacteristic.value[x]
    Definition

    Used for examplefor Out of Formulary, or any specifics.

    ShortAdditional characteristics of the catalog entry
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    64. Extension.extension:additionalClassification
    Slice NameadditionalClassification
    Definition

    User for example for ATC classification, or.

    ShortAdditional classification of the catalog entry
    Control0..*
    66. Extension.extension:additionalClassification.url
    Control1..1
    Fixed ValueadditionalClassification
    68. Extension.extension:additionalClassification.value[x]
    Definition

    User for example for ATC classification, or.

    ShortAdditional classification of the catalog entry
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    70. Extension.extension:relatedEntry
    Slice NamerelatedEntry
    Definition

    Used for example, to point to a substance, or to a device used to administer a medication.

    ShortAn item that this catalog entry is related to
    Control0..*
    72. Extension.extension:relatedEntry.extension
    Control2..*
    SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • value @ url
    • 74. Extension.extension:relatedEntry.extension:relationtype
      Slice Namerelationtype
      Definition

      The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

      Shorttriggers | is-replaced-by
      Control1..1
      76. Extension.extension:relatedEntry.extension:relationtype.url
      Control1..1
      Fixed Valuerelationtype
      78. Extension.extension:relatedEntry.extension:relationtype.value[x]
      Definition

      The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

      Shorttriggers | is-replaced-by
      BindingThe codes SHALL be taken from R4B_relation_type_for_R5 (0.0.1-snapshot-2)
      (required to http://hl7.org/fhir/4.3/ValueSet/R4B-relation-type-for-R5|0.0.1-snapshot-2)

      The type of relations between entries.

      Typecode
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      80. Extension.extension:relatedEntry.extension:item
      Slice Nameitem
      Definition

      This cross-version extension represents CatalogEntry.relatedEntry.item from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

      ShortThe reference to the related item
      Control1..1
      82. Extension.extension:relatedEntry.extension:item.url
      Control1..1
      Fixed Valueitem
      84. Extension.extension:relatedEntry.extension:item.value[x]
      Definition

      This cross-version extension represents CatalogEntry.relatedEntry.item from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

      ShortThe reference to the related item
      TypeReference
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      86. Extension.extension:relatedEntry.url
      Control1..1
      Fixed ValuerelatedEntry
      88. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-CatalogEntry

      Guidance on how to interpret the contents of this table can be foundhere

      0. Extension
      Definition

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


      Optional Extension Element - found in all resources.

      ShortAn entry in a catalogOptional Extensions Element
      Control0..*
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      2. Extension.extension
      Definition

      An Extension


      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortExtensionAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control20..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators:
      • value @ url
      • 4. Extension.extension:type
        Slice Nametype
        Definition

        This cross-version extension represents CatalogEntry.type from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

        ShortThe type of item - medication, device, service, protocol or otherAdditional content defined by implementations
        Control0..1*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        6. Extension.extension:type.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuetype
        8. Extension.extension:type.value[x]
        Definition

        This cross-version extension represents CatalogEntry.type from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortThe type of item - medication, device, service, protocol or otherValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. Extension.extension:orderable
        Slice Nameorderable
        Definition

        This cross-version extension represents CatalogEntry.orderable from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

        ShortWhether the entry represents an orderable itemAdditional content defined by implementations
        Control10..1*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        12. Extension.extension:orderable.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valueorderable
        14. Extension.extension:orderable.value[x]
        Definition

        This cross-version extension represents CatalogEntry.orderable from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortWhether the entry represents an orderable itemValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. Extension.extension:referencedItem
        Slice NamereferencedItem
        Definition

        The item in a catalog or definition.

        ShortThe item that is being definedAdditional content defined by implementations
        Control10..1*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Extension.extension:referencedItem.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed ValuereferencedItem
        20. Extension.extension:referencedItem.value[x]
        Definition

        The item in a catalog or definition.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortThe item that is being definedValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypeReference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Extension.extension:additionalIdentifier
        Slice NameadditionalIdentifier
        Definition

        Used in supporting related concepts, e.g. NDC to RxNorm.

        ShortAny additional identifier(s) for the catalog item, in the same granularity or conceptAdditional content defined by implementations
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Extension.extension:additionalIdentifier.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed ValueadditionalIdentifier
        26. Extension.extension:additionalIdentifier.value[x]
        Definition

        Used in supporting related concepts, e.g. NDC to RxNorm.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortAny additional identifier(s) for the catalog item, in the same granularity or conceptValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypeIdentifier, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. Extension.extension:classification
        Slice Nameclassification
        Definition

        Classes of devices, or ATC for medication.

        ShortClassification (category or class) of the item entryAdditional content defined by implementations
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        30. Extension.extension:classification.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valueclassification
        32. Extension.extension:classification.value[x]
        Definition

        Classes of devices, or ATC for medication.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortClassification (category or class) of the item entryValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Extension.extension:status
        Slice Namestatus
        Definition

        Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

        Shortdraft | active | retired | unknownAdditional content defined by implementations
        Control0..1*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        36. Extension.extension:status.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuestatus
        38. Extension.extension:status.value[x]
        Definition

        Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        Shortdraft | active | retired | unknownValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        BindingThe codes SHALL be taken from For codes, see R4B_publication_status_for_R5 (0.0.1-snapshot-2)
        (required to http://hl7.org/fhir/4.3/ValueSet/R4B-publication-status-for-R5|0.0.1-snapshot-2)

        The lifecycle status of an artifact.

        Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Extension.extension:validityPeriod
        Slice NamevalidityPeriod
        Definition

        This cross-version extension represents CatalogEntry.validityPeriod from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

        ShortThe time period in which this catalog entry is expected to be activeAdditional content defined by implementations
        Control0..1*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        42. Extension.extension:validityPeriod.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed ValuevalidityPeriod
        44. Extension.extension:validityPeriod.value[x]
        Definition

        This cross-version extension represents CatalogEntry.validityPeriod from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortThe time period in which this catalog entry is expected to be activeValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypePeriod, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Extension.extension:validTo
        Slice NamevalidTo
        Definition

        This cross-version extension represents CatalogEntry.validTo from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

        ShortThe date until which this catalog entry is expected to be activeAdditional content defined by implementations
        Control0..1*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        48. Extension.extension:validTo.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed ValuevalidTo
        50. Extension.extension:validTo.value[x]
        Definition

        This cross-version extension represents CatalogEntry.validTo from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortThe date until which this catalog entry is expected to be activeValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypedateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Extension.extension:lastUpdated
        Slice NamelastUpdated
        Definition

        Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

        ShortWhen was this catalog last updatedAdditional content defined by implementations
        Control0..1*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        54. Extension.extension:lastUpdated.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed ValuelastUpdated
        56. Extension.extension:lastUpdated.value[x]
        Definition

        Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortWhen was this catalog last updatedValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypedateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Extension.extension:additionalCharacteristic
        Slice NameadditionalCharacteristic
        Definition

        Used for examplefor Out of Formulary, or any specifics.

        ShortAdditional characteristics of the catalog entryAdditional content defined by implementations
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        60. Extension.extension:additionalCharacteristic.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed ValueadditionalCharacteristic
        62. Extension.extension:additionalCharacteristic.value[x]
        Definition

        Used for examplefor Out of Formulary, or any specifics.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortAdditional characteristics of the catalog entryValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. Extension.extension:additionalClassification
        Slice NameadditionalClassification
        Definition

        User for example for ATC classification, or.

        ShortAdditional classification of the catalog entryAdditional content defined by implementations
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        66. Extension.extension:additionalClassification.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed ValueadditionalClassification
        68. Extension.extension:additionalClassification.value[x]
        Definition

        User for example for ATC classification, or.


        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortAdditional classification of the catalog entryValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Extension.extension:relatedEntry
        Slice NamerelatedEntry
        Definition

        Used for example, to point to a substance, or to a device used to administer a medication.

        ShortAn item that this catalog entry is related toAdditional content defined by implementations
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        72. Extension.extension:relatedEntry.extension
        Definition

        An Extension


        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortExtensionAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control20..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators:
        • value @ url
        • 74. Extension.extension:relatedEntry.extension:relationtype
          Slice Namerelationtype
          Definition

          The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

          Shorttriggers | is-replaced-byAdditional content defined by implementations
          Control10..1*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          76. Extension.extension:relatedEntry.extension:relationtype.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuerelationtype
          78. Extension.extension:relatedEntry.extension:relationtype.value[x]
          Definition

          The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.


          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          Shorttriggers | is-replaced-byValue of extension
          Control0..1
          This element is affected by the following invariants: ext-1
          BindingThe codes SHALL be taken from For codes, see R4B_relation_type_for_R5 (0.0.1-snapshot-2)
          (required to http://hl7.org/fhir/4.3/ValueSet/R4B-relation-type-for-R5|0.0.1-snapshot-2)

          The type of relations between entries.

          Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          80. Extension.extension:relatedEntry.extension:item
          Slice Nameitem
          Definition

          This cross-version extension represents CatalogEntry.relatedEntry.item from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

          ShortThe reference to the related itemAdditional content defined by implementations
          Control10..1*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          82. Extension.extension:relatedEntry.extension:item.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valueitem
          84. Extension.extension:relatedEntry.extension:item.value[x]
          Definition

          This cross-version extension represents CatalogEntry.relatedEntry.item from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.


          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          ShortThe reference to the related itemValue of extension
          Control0..1
          This element is affected by the following invariants: ext-1
          TypeReference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          86. Extension.extension:relatedEntry.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed ValuerelatedEntry
          88. Extension.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-CatalogEntry

          Guidance on how to interpret the contents of this table can be foundhere

          0. Extension
          Definition

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

          ShortAn entry in a catalog
          Control0..*
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          2. Extension.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          This element is affected by the following invariants: ele-1
          Typeid
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          4. Extension.extension
          Definition

          An Extension

          ShortExtension
          Control2..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • value @ url
          • 6. Extension.extension:type
            Slice Nametype
            Definition

            This cross-version extension represents CatalogEntry.type from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

            ShortThe type of item - medication, device, service, protocol or other
            Control0..1
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            8. Extension.extension:type.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            This element is affected by the following invariants: ele-1
            Typeid
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            10. Extension.extension:type.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 12. Extension.extension:type.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuetype
              14. Extension.extension:type.value[x]
              Definition

              This cross-version extension represents CatalogEntry.type from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

              ShortThe type of item - medication, device, service, protocol or other
              Control0..1
              This element is affected by the following invariants: ext-1
              TypeCodeableConcept
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              16. Extension.extension:orderable
              Slice Nameorderable
              Definition

              This cross-version extension represents CatalogEntry.orderable from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

              ShortWhether the entry represents an orderable item
              Control1..1
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              18. Extension.extension:orderable.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              This element is affected by the following invariants: ele-1
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              20. Extension.extension:orderable.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 22. Extension.extension:orderable.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies the meaning of the extension
                Comments

                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valueorderable
                24. Extension.extension:orderable.value[x]
                Definition

                This cross-version extension represents CatalogEntry.orderable from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

                ShortWhether the entry represents an orderable item
                Control0..1
                This element is affected by the following invariants: ext-1
                Typeboolean
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. Extension.extension:referencedItem
                Slice NamereferencedItem
                Definition

                The item in a catalog or definition.

                ShortThe item that is being defined
                Control1..1
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                28. Extension.extension:referencedItem.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                This element is affected by the following invariants: ele-1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                30. Extension.extension:referencedItem.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 32. Extension.extension:referencedItem.url
                  Definition

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies the meaning of the extension
                  Comments

                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed ValuereferencedItem
                  34. Extension.extension:referencedItem.value[x]
                  Definition

                  The item in a catalog or definition.

                  ShortThe item that is being defined
                  Control0..1
                  This element is affected by the following invariants: ext-1
                  TypeReference
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  36. Extension.extension:additionalIdentifier
                  Slice NameadditionalIdentifier
                  Definition

                  Used in supporting related concepts, e.g. NDC to RxNorm.

                  ShortAny additional identifier(s) for the catalog item, in the same granularity or concept
                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  38. Extension.extension:additionalIdentifier.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  40. Extension.extension:additionalIdentifier.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 42. Extension.extension:additionalIdentifier.url
                    Definition

                    Source of the definition for the extension code - a logical name or a URL.

                    Shortidentifies the meaning of the extension
                    Comments

                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed ValueadditionalIdentifier
                    44. Extension.extension:additionalIdentifier.value[x]
                    Definition

                    Used in supporting related concepts, e.g. NDC to RxNorm.

                    ShortAny additional identifier(s) for the catalog item, in the same granularity or concept
                    Control0..1
                    This element is affected by the following invariants: ext-1
                    TypeIdentifier
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    46. Extension.extension:classification
                    Slice Nameclassification
                    Definition

                    Classes of devices, or ATC for medication.

                    ShortClassification (category or class) of the item entry
                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    48. Extension.extension:classification.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    50. Extension.extension:classification.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 52. Extension.extension:classification.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies the meaning of the extension
                      Comments

                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valueclassification
                      54. Extension.extension:classification.value[x]
                      Definition

                      Classes of devices, or ATC for medication.

                      ShortClassification (category or class) of the item entry
                      Control0..1
                      This element is affected by the following invariants: ext-1
                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      56. Extension.extension:status
                      Slice Namestatus
                      Definition

                      Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

                      Shortdraft | active | retired | unknown
                      Control0..1
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      58. Extension.extension:status.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      60. Extension.extension:status.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 62. Extension.extension:status.url
                        Definition

                        Source of the definition for the extension code - a logical name or a URL.

                        Shortidentifies the meaning of the extension
                        Comments

                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                        Control1..1
                        Typeuri
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Fixed Valuestatus
                        64. Extension.extension:status.value[x]
                        Definition

                        Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

                        Shortdraft | active | retired | unknown
                        Control0..1
                        This element is affected by the following invariants: ext-1
                        BindingThe codes SHALL be taken from R4B_publication_status_for_R5 (0.0.1-snapshot-2)
                        (required to http://hl7.org/fhir/4.3/ValueSet/R4B-publication-status-for-R5|0.0.1-snapshot-2)

                        The lifecycle status of an artifact.

                        Typecode
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        66. Extension.extension:validityPeriod
                        Slice NamevalidityPeriod
                        Definition

                        This cross-version extension represents CatalogEntry.validityPeriod from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

                        ShortThe time period in which this catalog entry is expected to be active
                        Control0..1
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        68. Extension.extension:validityPeriod.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        70. Extension.extension:validityPeriod.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 72. Extension.extension:validityPeriod.url
                          Definition

                          Source of the definition for the extension code - a logical name or a URL.

                          Shortidentifies the meaning of the extension
                          Comments

                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Fixed ValuevalidityPeriod
                          74. Extension.extension:validityPeriod.value[x]
                          Definition

                          This cross-version extension represents CatalogEntry.validityPeriod from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

                          ShortThe time period in which this catalog entry is expected to be active
                          Control0..1
                          This element is affected by the following invariants: ext-1
                          TypePeriod
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          76. Extension.extension:validTo
                          Slice NamevalidTo
                          Definition

                          This cross-version extension represents CatalogEntry.validTo from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

                          ShortThe date until which this catalog entry is expected to be active
                          Control0..1
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          78. Extension.extension:validTo.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          80. Extension.extension:validTo.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 82. Extension.extension:validTo.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed ValuevalidTo
                            84. Extension.extension:validTo.value[x]
                            Definition

                            This cross-version extension represents CatalogEntry.validTo from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

                            ShortThe date until which this catalog entry is expected to be active
                            Control0..1
                            This element is affected by the following invariants: ext-1
                            TypedateTime
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            86. Extension.extension:lastUpdated
                            Slice NamelastUpdated
                            Definition

                            Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

                            ShortWhen was this catalog last updated
                            Control0..1
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            88. Extension.extension:lastUpdated.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            This element is affected by the following invariants: ele-1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            90. Extension.extension:lastUpdated.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 92. Extension.extension:lastUpdated.url
                              Definition

                              Source of the definition for the extension code - a logical name or a URL.

                              Shortidentifies the meaning of the extension
                              Comments

                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                              Control1..1
                              Typeuri
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              Fixed ValuelastUpdated
                              94. Extension.extension:lastUpdated.value[x]
                              Definition

                              Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

                              ShortWhen was this catalog last updated
                              Control0..1
                              This element is affected by the following invariants: ext-1
                              TypedateTime
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              96. Extension.extension:additionalCharacteristic
                              Slice NameadditionalCharacteristic
                              Definition

                              Used for examplefor Out of Formulary, or any specifics.

                              ShortAdditional characteristics of the catalog entry
                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              98. Extension.extension:additionalCharacteristic.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              100. Extension.extension:additionalCharacteristic.extension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              ShortAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 102. Extension.extension:additionalCharacteristic.url
                                Definition

                                Source of the definition for the extension code - a logical name or a URL.

                                Shortidentifies the meaning of the extension
                                Comments

                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                Fixed ValueadditionalCharacteristic
                                104. Extension.extension:additionalCharacteristic.value[x]
                                Definition

                                Used for examplefor Out of Formulary, or any specifics.

                                ShortAdditional characteristics of the catalog entry
                                Control0..1
                                This element is affected by the following invariants: ext-1
                                TypeCodeableConcept
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                106. Extension.extension:additionalClassification
                                Slice NameadditionalClassification
                                Definition

                                User for example for ATC classification, or.

                                ShortAdditional classification of the catalog entry
                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                108. Extension.extension:additionalClassification.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                110. Extension.extension:additionalClassification.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 112. Extension.extension:additionalClassification.url
                                  Definition

                                  Source of the definition for the extension code - a logical name or a URL.

                                  Shortidentifies the meaning of the extension
                                  Comments

                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                  Control1..1
                                  Typeuri
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  Fixed ValueadditionalClassification
                                  114. Extension.extension:additionalClassification.value[x]
                                  Definition

                                  User for example for ATC classification, or.

                                  ShortAdditional classification of the catalog entry
                                  Control0..1
                                  This element is affected by the following invariants: ext-1
                                  TypeCodeableConcept
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  116. Extension.extension:relatedEntry
                                  Slice NamerelatedEntry
                                  Definition

                                  Used for example, to point to a substance, or to a device used to administer a medication.

                                  ShortAn item that this catalog entry is related to
                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  118. Extension.extension:relatedEntry.id
                                  Definition

                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  120. Extension.extension:relatedEntry.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control2..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 122. Extension.extension:relatedEntry.extension:relationtype
                                    Slice Namerelationtype
                                    Definition

                                    The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

                                    Shorttriggers | is-replaced-by
                                    Control1..1
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    124. Extension.extension:relatedEntry.extension:relationtype.id
                                    Definition

                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    126. Extension.extension:relatedEntry.extension:relationtype.extension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                    ShortAdditional content defined by implementations
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    SlicingThis element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 128. Extension.extension:relatedEntry.extension:relationtype.url
                                      Definition

                                      Source of the definition for the extension code - a logical name or a URL.

                                      Shortidentifies the meaning of the extension
                                      Comments

                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                      Control1..1
                                      Typeuri
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      Fixed Valuerelationtype
                                      130. Extension.extension:relatedEntry.extension:relationtype.value[x]
                                      Definition

                                      The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

                                      Shorttriggers | is-replaced-by
                                      Control0..1
                                      This element is affected by the following invariants: ext-1
                                      BindingThe codes SHALL be taken from R4B_relation_type_for_R5 (0.0.1-snapshot-2)
                                      (required to http://hl7.org/fhir/4.3/ValueSet/R4B-relation-type-for-R5|0.0.1-snapshot-2)

                                      The type of relations between entries.

                                      Typecode
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      132. Extension.extension:relatedEntry.extension:item
                                      Slice Nameitem
                                      Definition

                                      This cross-version extension represents CatalogEntry.relatedEntry.item from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

                                      ShortThe reference to the related item
                                      Control1..1
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      134. Extension.extension:relatedEntry.extension:item.id
                                      Definition

                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      This element is affected by the following invariants: ele-1
                                      Typeid
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      136. Extension.extension:relatedEntry.extension:item.extension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                      ShortAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 138. Extension.extension:relatedEntry.extension:item.url
                                        Definition

                                        Source of the definition for the extension code - a logical name or a URL.

                                        Shortidentifies the meaning of the extension
                                        Comments

                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                        Control1..1
                                        Typeuri
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        Fixed Valueitem
                                        140. Extension.extension:relatedEntry.extension:item.value[x]
                                        Definition

                                        This cross-version extension represents CatalogEntry.relatedEntry.item from http://hl7.org/fhir/StructureDefinition/CatalogEntry|4.3.0 for use in FHIR R5.

                                        ShortThe reference to the related item
                                        Control0..1
                                        This element is affected by the following invariants: ext-1
                                        TypeReference
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        142. Extension.extension:relatedEntry.url
                                        Definition

                                        Source of the definition for the extension code - a logical name or a URL.

                                        Shortidentifies the meaning of the extension
                                        Comments

                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                        Control1..1
                                        Typeuri
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        Fixed ValuerelatedEntry
                                        144. Extension.extension:relatedEntry.value[x]
                                        Definition

                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                        ShortValue of extension
                                        Control0..1
                                        This element is affected by the following invariants: ext-1
                                        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        146. Extension.url
                                        Definition

                                        Source of the definition for the extension code - a logical name or a URL.

                                        Shortidentifies the meaning of the extension
                                        Comments

                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                        Control1..1
                                        Typeuri
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-CatalogEntry
                                        148. Extension.value[x]
                                        Definition

                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                        ShortValue of extension
                                        Control0..1
                                        This element is affected by the following invariants: ext-1
                                        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))