Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Extension: ExtensionMedication_Batch - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R4B-Medication.batch extension.

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

0. Extension
Definition

R4B: Medication.batch (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR4B: Details about packaged medications (new)Optional Extensions Element
Comments

Element Medication.batch has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Control0..1*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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() | (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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:lotNumber
    Slice NamelotNumber
    Definition

    R4B: Medication.batch.lotNumber (new:string)

    ShortR4B: Identifier assigned to batch (new)Additional Content defined by implementations
    Comments

    Element Medication.batch.lotNumber is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.lotNumber has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.lotNumber has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Requirements

    Element Medication.batch.lotNumber is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.lotNumber has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.lotNumber has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    6. Extension.extension:lotNumber.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuelotNumber
    8. Extension.extension:lotNumber.value[x]
    Definition

    The assigned lot number of a batch of the specified product.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortIdentifier assigned to batchValue of extension
    Control0..1
    Typestring, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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
    10. Extension.extension:expirationDate
    Slice NameexpirationDate
    Definition

    R4B: Medication.batch.expirationDate (new:dateTime)

    ShortR4B: When batch will expire (new)Additional Content defined by implementations
    Comments

    Element Medication.batch.expirationDate is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.expirationDate has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.expirationDate has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Requirements

    Element Medication.batch.expirationDate is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.expirationDate has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.expirationDate has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    12. Extension.extension:expirationDate.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueexpirationDate
    14. Extension.extension:expirationDate.value[x]
    Definition

    When this specific batch of product will expire.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortWhen batch will expireValue of extension
    Control0..1
    TypedateTime, date, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-Medication.batch
    18. Extension.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. Extension
    Definition

    R4B: Medication.batch (new:BackboneElement)

    ShortR4B: Details about packaged medications (new)
    Comments

    Element Medication.batch has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    Is Modifierfalse
    2. Extension.extension
    Control0..*
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Extension.extension:lotNumber
      Slice NamelotNumber
      Definition

      R4B: Medication.batch.lotNumber (new:string)

      ShortR4B: Identifier assigned to batch (new)
      Comments

      Element Medication.batch.lotNumber is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.lotNumber has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.lotNumber has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Medication.batch.lotNumber is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.lotNumber has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.lotNumber has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:lotNumber.url
      Control1..1
      Fixed ValuelotNumber
      8. Extension.extension:lotNumber.value[x]
      Definition

      The assigned lot number of a batch of the specified product.

      ShortIdentifier assigned to batch
      Control0..1
      Typestring
      [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
      10. Extension.extension:expirationDate
      Slice NameexpirationDate
      Definition

      R4B: Medication.batch.expirationDate (new:dateTime)

      ShortR4B: When batch will expire (new)
      Comments

      Element Medication.batch.expirationDate is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.expirationDate has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.expirationDate has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Medication.batch.expirationDate is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.expirationDate has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.expirationDate has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:expirationDate.url
      Control1..1
      Fixed ValueexpirationDate
      14. Extension.extension:expirationDate.value[x]
      Definition

      When this specific batch of product will expire.

      ShortWhen batch will expire
      Control0..1
      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
      16. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-Medication.batch
      18. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R4B: Medication.batch (new:BackboneElement)

      ShortR4B: Details about packaged medications (new)
      Comments

      Element Medication.batch has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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.

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.extension:lotNumber
        Slice NamelotNumber
        Definition

        R4B: Medication.batch.lotNumber (new:string)

        ShortR4B: Identifier assigned to batch (new)
        Comments

        Element Medication.batch.lotNumber is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.lotNumber has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.lotNumber has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension
        Requirements

        Element Medication.batch.lotNumber is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.lotNumber has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.lotNumber has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        8. Extension.extension:lotNumber.id
        Definition

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        10. Extension.extension:lotNumber.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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
        Alternate Namesextensions, user content
        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:lotNumber.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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuelotNumber
          14. Extension.extension:lotNumber.value[x]
          Definition

          The assigned lot number of a batch of the specified product.

          ShortIdentifier assigned to batch
          Control0..1
          Typestring
          [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:expirationDate
          Slice NameexpirationDate
          Definition

          R4B: Medication.batch.expirationDate (new:dateTime)

          ShortR4B: When batch will expire (new)
          Comments

          Element Medication.batch.expirationDate is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.expirationDate has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.expirationDate has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension
          Requirements

          Element Medication.batch.expirationDate is part of an existing definition because parent element Medication.batch requires a cross-version extension. Element Medication.batch.expirationDate has a context of Medication based on following the parent source element upwards and mapping to Medication. Element Medication.batch.expirationDate has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          18. Extension.extension:expirationDate.id
          Definition

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          20. Extension.extension:expirationDate.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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
          Alternate Namesextensions, user content
          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:expirationDate.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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueexpirationDate
            24. Extension.extension:expirationDate.value[x]
            Definition

            When this specific batch of product will expire.

            ShortWhen batch will expire
            Control0..1
            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
            26. 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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-Medication.batch
            28. Extension.value[x]
            Definition

            Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

            ShortValue of extension
            Control0..0
            TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension