codeSets
http://www.sifassociation.org/infrastructure/3.2.1
Documentation
The Code Set Registry Service provides a way for all legal codes to be defined outside of the SIF Specification while allowing changes (additions and replacements) of external code set values to be easily verified by the recipient so as not to break existing Consumer / Provider interoperability.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath | Format |
---|---|---|---|---|---|---|
@id | string | /codeSets/codeSet/@id | ||||
zone | * | M | token | If this is tied to a specific zone it is specified here, otherwise “environment-global” indicates applicability to all zones in the Environment. | /codeSets/codeSet/zone | |
version | * | M | versionType | The official major, minor, and revision version of the code set. | /codeSets/codeSet/version | [0-9]{1,3}[.][0-9]{1,3}([.][0-9]{1,3})? |
timestamp | * | M | dateTime | The date and time of the last change to this code set. So that only updates can be queried efficiently (where applicable). | /codeSets/codeSet/timestamp | |
source | CN | uriType | URL to an external code set whose values are not (yet) present in the system. | /codeSets/codeSet/source | ||
code | * | MI | string | Official abbreviation for the given value. | /codeSets/codeSet/codeItems/codeItem/code | |
source | QN | uriType | URL where the related abbreviation comes from. | /codeSets/codeSet/codeItems/codeItem/source | ||
namespace | QN | uriType | Namespace where the related abbreviation comes from. | /codeSets/codeSet/codeItems/codeItem/namespace | ||
value | * | QN | string | What the code represent. | /codeSets/codeSet/codeItems/codeItem/value | |
description | ON | string | Human readable explanation of what the code represents. | /codeSets/codeSet/codeItems/codeItem/description | ||
definition | ON | string | Human readable explanation provided by the source! | /codeSets/codeSet/codeItems/codeItem/definition | ||
old | * | M | boolean | Indicates the alias code has been deprecated or deleted, even if it no longer appears in the register. | /codeSets/codeSet/codeItems/codeItem/aliases/alias/code/old | |
official | * | M | boolean | Indicates the alias code is an official one; however the locale uses this one to represent that concept, at least in part. | /codeSets/codeSet/codeItems/codeItem/aliases/alias/code/official | |
value | * | M | string | Alternate abbreviation that might need to be more specific or correct. | /codeSets/codeSet/codeItems/codeItem/aliases/alias/code/value | |
source | QN | uriType | URL where the related abbreviation comes from. | /codeSets/codeSet/codeItems/codeItem/aliases/alias/source | ||
namespace | QN | uriType | Namespace where the related abbreviation comes from. | /codeSets/codeSet/codeItems/codeItem/aliases/alias/namespace | ||
action | * | M | string | The last action to be taken for this code item. | /codeSets/codeSet/codeItems/codeItem/action | ADD, CHANGE, DEPRECATED, DELETE |
timestamp | * | M | dateTime | The date and time of the last action taken on this code item. So that only updates can be queried efficiently (where applicable). | /codeSets/codeSet/codeItems/codeItem/timestamp |
Download: .xlsx
XML Structure
Download: .xml