Data Model Libraries
    Preparing search index...

    Class TerminologyCapabilitiesCodeSystemVersionComponent

    TerminologyCapabilitiesCodeSystemVersionComponent Class

    FHIR Specification

    • Short: Version of Code System supported
    • Definition: For the code system, a list of versions that are supported by the server.
    • Comment: Language translations might not be available for all codes.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code?: StringType

    TerminologyCapabilities.codeSystem.version.code Element

    FHIR Specification

    • Short: Version identifier for this version
    • Definition: For version-less code systems, there should be a single version with no identifier.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    isDefault?: BooleanType

    TerminologyCapabilities.codeSystem.version.isDefault Element

    FHIR Specification

    • Short: If this is the default version for this code system
    • Definition: If this is the default version for this code system.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    compositional?: BooleanType

    TerminologyCapabilities.codeSystem.version.compositional Element

    FHIR Specification

    • Short: If compositional grammar is supported
    • Definition: If the compositional grammar defined by the code system is supported.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    language?: CodeType[]

    TerminologyCapabilities.codeSystem.version.language Element

    FHIR Specification

    • Short: Language Displays supported
    • Definition: Language Displays supported.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    TerminologyCapabilities.codeSystem.version.filter Element

    FHIR Specification

    • Short: Filter Properties supported
    • Definition: Filter Properties supported.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    property?: CodeType[]

    TerminologyCapabilities.codeSystem.version.property Element

    FHIR Specification

    • Short: Properties supported for $lookup
    • Definition: Properties supported for $lookup.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TerminologyCapabilitiesCodeSystemVersionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TerminologyCapabilitiesCodeSystemVersionComponent

      TerminologyCapabilitiesCodeSystemVersionComponent data model or undefined for TerminologyCapabilitiesCodeSystemVersionComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 complex or primitive datatype; false otherwise