Terminology Package

Overview

The base.base_types.terminology package defines the CODE_PHRASE type. It represents a fully coordinated term obtained from a terminology service, identified by a TERMINOLOGY_ID (from the identification package) together with a code_string.

CODE_PHRASE is retained for legacy purposes only, while the ADL 1.4 / AOM 1.4 model requires it. New models should instead use the Terminology_code and Terminology_term types defined in the Foundation Types specification.

Class Definitions

CODE_PHRASE Class

  • Definition

  • Effective

  • BMM

  • UML

Class

CODE_PHRASE

Description

A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).

Retain for LEGACY only, while ADL1.4 requires CODE_PHRASE.

Attributes

Signature

Meaning

1..1

terminology_id: TERMINOLOGY_ID

Identifier of the distinct terminology from which the code_string (or its elements) was extracted.

1..1

code_string: String

The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

0..1

preferred_term: String

Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

Invariants

Code_string_valid: not code_string.is_empty
CODE_PHRASE

A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).

Retain for LEGACY only, while ADL1.4 requires CODE_PHRASE.

Attributes

terminology_id: TERMINOLOGY_ID [1..1]

Identifier of the distinct terminology from which the code_string (or its elements) was extracted.

code_string: String [1..1]

The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

preferred_term: String [0..1]

Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

Invariants

Code_string_valid: not code_string.is_empty

 
{
    "name": "CODE_PHRASE",
    "documentation": "A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).\n\nRetain for LEGACY only, while ADL1.4 requires CODE_PHRASE.",
    "properties": {
        "terminology_id": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "terminology_id",
            "documentation": "Identifier of the distinct terminology from which the code_string (or its elements) was extracted.",
            "is_mandatory": true,
            "type": "TERMINOLOGY_ID"
        },
        "code_string": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "code_string",
            "documentation": "The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context. ",
            "is_mandatory": true,
            "type": "String"
        },
        "preferred_term": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "preferred_term",
            "documentation": "Optional attribute to carry preferred term corresponding to the code or expression in `_code_string_`. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.",
            "type": "String"
        }
    },
    "invariants": {
        "Code_string_valid": "not code_string.is_empty"
    }
}
code phrase