CodingSystemType

From OpenIndivo Documentation Wiki

Contents 1 Overview 2 Detailed Schema Description 2.1 CodingSystemType 2.2 CodeDefintionType 2.3 DisplayType

Overview

This schema defines how coding systems are to be written. The main block includes metadata about the coding system, followed by individual code definitions used to populate CodedValueType fields.

For details on how to use coding systems, visit Coding Systems.

Detailed Schema Description

CodingSystemType

ServiceLocation

anyURI (required)

A web-accessible URI which identifies a REST-based web service that will provide information about this coding system and its codes.

ShortDescription

string (required)

A brief description of this coding system (formerly "Name")

LongDescription

string (required)

A more detailed description of this coding system.

Author

string (required)

The original author of the codes represented by this system. For example, if the Indivo team has converted an ISO code set into a CodingSystem, the author would be the International Organization for Standardization.

Date

string (required)

The date that the coding system was created.

MajorVersion

string (required)

The major version of the coding system.

MinorVersion

string (required)

The minor (or "dot") version of the coding system.

CodeDefinition

CodeDefinitionType (required, multiple)

List of the codes contained in the coding system.

CodeDefintionType

Represents a code within a coding system.

Code

string (required)

The code itself.

Display

DisplayType (required)

How the code should be displayed to users based on their language locale. Each DisplayType MUST have a distinct lang attribute.

Explanation

string (optional)

A brief explanation of the code's meaning, if necessary.

AdditionalInformation

anyType (optional)

Any additional data that is related to this code, if necessary.

DisplayType

Describes how a code should be displayed to users based on their language locale.

Value

string (required)

The display value of the code in this particular language locale.

Abbreviation

string (optional)

The abbreviated value of the code. This MUST be in plain ASCII. HTMLAbbreviation can be used for specially formatted abbreviations.

HTMLAbbreviation

string (optional)

The HTML-encoded version of the abbreviated value.

lang attribute

string (optional)

The language locale that this display is used for. See ISO 639.2 3-character language code.