Data Model Libraries
    Preparing search index...

    EnumCode Class

    Extends CodeType to include the code system enumeration and the full FHIR definition of each code value.

    FHIR Specification

    • Short: Primitive Type code
    • Definition: A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    • FHIR Version: N/A

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    codeEnum: any
    fhirCodeObject: any
    initElementProps: any

    Accessors

    Methods

    • Returns string

    • Assigns the provided value.

      Parameters

      • Optionalvalue: string

        the generic T value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if the instance is empty; false otherwise

    • Returns string

      the FHIR type defined in the FHIR standard

    • Returns string

      the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)

    • Creates a copy of the current instance.

      Returns EnumCodeType

      the a new instance copied from the current instance

    • Encodes the provided generic T value as a string.

      Parameters

      • value: string

        the generic T value

      Returns string

      the string representation of T

      PrimitiveTypeError for invalid value

    • Parses the provided string value and coerces it into the generic T value.

      Parameters

      • value: string

        the string representation of the generic T value

      Returns string

      the generic T value

      PrimitiveTypeError for invalid value

    • Returns boolean

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

    • Returns undefined | string

      the generic T property value

    • Returns boolean

      true if the generic T value exists and has a value; false otherwise

    • Returns undefined | string

      the generic T property value as a string

    • Assigns the provided value and coerces it to the T type.

      Parameters

      • Optionalvalue: string

        the string value of the primitive type

      Returns void

      PrimitiveTypeError for invalid value

    • Returns boolean

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

    • 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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex 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 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

    • Copies the current instance's elements into the provided object.

      Parameters

      Returns void