Data Model Libraries
    Preparing search index...

    Class CodeableConcept

    CodeableConcept Class

    Base StructureDefinition for CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

    This is a common pattern in healthcare - a concept that may be defined by one or more codes from formal definitions including LOINC and SNOMED CT, and/or defined by the provision of text that captures a human sense of the concept.

    FHIR Specification

    • Short: Concept - reference to a terminology or just text
    • Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
    • Comment: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
    • FHIR Version: 4.0.1; Normative since 4.0.0

    FHIR CodeableConcept

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    coding? text? initCoding

    Methods

    parse getCoding setCoding addCoding hasCoding getTextElement setTextElement hasTextElement getText setText hasText fhirType isEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    coding?: any

    CodeableConcept.coding Element

    FHIR Specification

    • Short: Code defined by a terminology system
    • Definition: A reference to a code defined by a terminology system.
    • Comment: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
    • Requirements: Allows for alternative encodings within a code system, and translations to other code systems.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Private Optionaltext

    text?: any

    CodeableConcept.text Element

    FHIR Specification

    • Short: Plain text representation of the concept
    • Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
    • Comment: Very often the text is the same as a displayName of one of the codings.
    • Requirements: The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    initCoding: any

    Initialize the coding property

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CodeableConcept

      • OptionaloptSourceField: string

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

      Returns undefined | CodeableConcept

      CodeableConcept data model or undefined for CodeableConcept

      JsonError if the provided JSON is not a valid JSON object

    • Returns Coding[]

      the coding property value as a Coding array

    • Assigns the provided Coding array value to the coding property.

      Parameters

      • value: undefined | Coding[]

        the coding array value

      Returns this

      this

    • Add the provided Coding value to the coding array property.

      Parameters

      • value: undefined | Coding

        the coding value

      Returns this

      this

    • Returns boolean

      true if the coding property exists and has a value; false otherwise

    • Returns StringType

      the text property value as a StringType object if defined; else an empty StringType object

    • Assigns the provided PrimitiveType value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Returns undefined | string

      the text property value as a fhirString if defined; else undefined

    • Assigns the provided primitive value to the text property.

      Parameters

      • value: undefined | string

        the text value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Returns string

      the FHIR type defined in the FHIR standard

    • Returns boolean

      true if the instance is empty; false otherwise

    • Returns boolean

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

    • Returns string

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

    • Returns undefined | Value

      the JSON value or undefined if the instance is empty

    • 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 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

    • Protected

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

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods