Data Model Libraries
    Preparing search index...

    CodeSystemPropertyComponent Class

    FHIR Specification

    • Short: Additional information supplied about each concept
    • Definition: A property defines an additional slot through which additional information can be provided about a concept.
    • Comment: Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeType

    CodeSystem.property.code Element

    FHIR Specification

    • Short: Identifies the property on the concepts, and when referred to in operations
    • Definition: A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    uri?: UriType

    CodeSystem.property.uri Element

    FHIR Specification

    • Short: Formal identifier for the property
    • Definition: Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    CodeSystem.property.description Element

    FHIR Specification

    • Short: Why the property is defined, and/or what it conveys
    • Definition: A description of the property- why it is defined, and how its value might be used.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    conceptPropertyTypeEnum: ConceptPropertyTypeEnum

    FHIR CodeSystem: ConceptPropertyType

    type_: null | EnumCodeType

    CodeSystem.property.type Element

    FHIR Specification

    • Short: code | Coding | string | integer | boolean | dateTime | decimal
    • Definition: The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept).
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ConceptPropertyTypeEnum

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CodeSystemPropertyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CodeSystemPropertyComponent

      CodeSystemPropertyComponent data model or undefined for CodeSystemPropertyComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise