Data Model Libraries
    Preparing search index...

    Class ElementDefinitionSlicingComponent

    ElementDefinitionSlicingComponent Class

    FHIR Specification

    • Short: This element is sliced - slices follow
    • Definition: Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
    • Comment: The first element in the sequence, the one that carries the slicing, is the definition that applies to all the slices. This is based on the unconstrained element, but can apply any constraints as appropriate. This may include the common constraints on the children of the element.

    FHIR ElementDefinition

    Hierarchy (View Summary)

    • DataType
      • ElementDefinitionSlicingComponent

    Implements

    Index

    Constructors

    constructor

    Properties

    discriminator? description? ordered? resourceSlicingRulesEnum rules

    Methods

    parse getDiscriminator setDiscriminator addDiscriminator hasDiscriminator getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getOrderedElement setOrderedElement hasOrderedElement getOrdered setOrdered hasOrdered getRulesEnumType setRulesEnumType hasRulesEnumType getRulesElement setRulesElement hasRulesElement getRules setRules hasRules fhirType isEmpty isRequiredFieldsEmpty copy dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initDiscriminator

    Constructors

    Properties

    discriminator?: ElementDefinitionSlicingDiscriminatorComponent[]

    ElementDefinition.slicing.discriminator Element

    FHIR Specification

    • Short: Element values that are used to distinguish the slices
    • Definition: Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.
    • Comment: If there is no discriminator, the content is hard to process, so this should be avoided.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: StringType

    ElementDefinition.slicing.description Element

    FHIR Specification

    • Short: Text description of how slicing works (or not)
    • Definition: A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.
    • Comment: If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    ordered?: BooleanType

    ElementDefinition.slicing.ordered Element

    FHIR Specification

    • Short: If elements must be in same order as slices
    • Definition: If the matching elements have to occur in the same order as defined in the profile.
    • Comment: Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resourceSlicingRulesEnum: ResourceSlicingRulesEnum

    FHIR CodeSystem: ResourceSlicingRules

    ResourceSlicingRulesEnum

    rules: null | EnumCodeType

    ElementDefinition.slicing.rules Element

    FHIR Specification

    • Short: closed | open | openAtEnd
    • Definition: Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.
    • Comment: Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ResourceSlicingRulesEnum

    Methods

    • Parse the provided ElementDefinitionSlicingComponent JSON to instantiate the ElementDefinitionSlicingComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinitionSlicingComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ElementDefinitionSlicingComponent

      Returns undefined | ElementDefinitionSlicingComponent

      ElementDefinitionSlicingComponent data model or undefined for ElementDefinitionSlicingComponent

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods