FHIR Osiris Implementation Guide
2.1.0 - ci-build

FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: TreatmentLine - Detailed Descriptions

Draft as of 2024-03-21

Definitions for the treatment-line extension.

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

0. Extension
Definition

The treatment line number

ShortTreatment Line Number
2. Extension.extension
Control0..0
4. Extension.url
Fixed Valuehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line
6. Extension.value[x]
Typeinteger, date, Meta, Address, Attachment, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 8. Extension.value[x]:valueInteger
    Slice NamevalueInteger
    Definition

    Line number the treatment

    ShortLine number the treatment
    Control0..1
    Typeinteger
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue

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

    0. Extension
    Definition

    The treatment line number


    Optional Extension Element - found in all resources.

    ShortTreatment Line NumberOptional Extensions Element
    Control0..*
    This element is affected by the following invariants: ele-1
    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.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 manageable, 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.

    Control0..0*
    This element is affected by the following invariants: ele-1
    TypeExtension
    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. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. 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
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed Valuehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line
      6. 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: ele-1
      Typeinteger, date, Meta, Address, Attachment, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
      • type @ $this
      • 8. Extension.value[x]:valueInteger
        Slice NamevalueInteger
        Definition

        Line number the treatment


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

        ShortLine number the treatmentValue of extension
        Control0..1
        This element is affected by the following invariants: ele-1
        Typeinteger, date, Meta, Address, Attachment, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

        0. Extension
        Definition

        The treatment line number

        ShortTreatment Line Number
        Control0..*
        This element is affected by the following invariants: ele-1
        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
        Typestring
        XML FormatIn the XML format, this property is represented as an attribute.
        4. Extension.extension
        Definition

        An Extension

        ShortExtension
        Control0..0
        This element is affected by the following invariants: ele-1
        TypeExtension
        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 are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 6. 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
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed Valuehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line
          8. 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: ele-1
          Typeinteger
          [x] NoteSee Choice of Data Types for further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
          • type @ $this
          • 10. Extension.value[x]:valueInteger
            Slice NamevalueInteger
            Definition

            Line number the treatment

            ShortLine number the treatment
            Control0..1
            This element is affected by the following invariants: ele-1
            Typeinteger
            [x] NoteSee Choice of Data Types for further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))