|
|
Zeile 30: |
Zeile 30: |
| <td></td> <td id="cardinality_cell">0..1</td> | | <td></td> <td id="cardinality_cell">0..1</td> |
| <td>Name of codesystem. Each codesystem requires at least one version.</td> | | <td>Name of codesystem. Each codesystem requires at least one version.</td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">codeSystemType</td>
| |
− | <td>String</td>
| |
− | <td>30</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">currentVersionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Version of the Code System</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">description</td>
| |
− | <td>String</td>
| |
− | <td>65535</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Narrative description of Code System</td>
| |
| </tr> | | </tr> |
| <tr> | | <tr> |
Zeile 60: |
Zeile 37: |
| <td></td> <td id="cardinality_cell">1..1</td> | | <td></td> <td id="cardinality_cell">1..1</td> |
| <td>Internal ID = Primary Key of Code System</td> | | <td>Internal ID = Primary Key of Code System</td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">insertTimestamp</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Timestamp, when the Code System was inserted</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">name</td>
| |
− | <td>String</td>
| |
− | <td>100</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
| |
| </tr> | | </tr> |
| <tr id="row_object"> | | <tr id="row_object"> |
Zeile 82: |
Zeile 44: |
| <td></td> <td id="cardinality_cell">1..1</td> | | <td></td> <td id="cardinality_cell">1..1</td> |
| <td>Version of a Code System</td> | | <td>Version of a Code System</td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">codeSystemId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td></td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">description</td>
| |
− | <td>String</td>
| |
− | <td>65535</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Description of the Code System</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">expirationDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point of time the Code System looses its validity.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">insertTimestamp</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point of time when the Code System Version was inserted.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">licenceHolder</td>
| |
− | <td>String</td>
| |
− | <td>65535</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Owner of the licence.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">name</td>
| |
− | <td>String</td>
| |
− | <td>100</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Complete Name of the Code System.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">oid</td>
| |
− | <td>String</td>
| |
− | <td>100</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Official OID</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">preferredLanguageCd</td>
| |
− | <td>String</td>
| |
− | <td>30</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">previousVersionID</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Refers to the prior version, if there are more than one.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">releaseDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point of time, when this version starts to be valid.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">source</td>
| |
− | <td>String</td>
| |
− | <td>65535</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Source of the Code System Version</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">status</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Status of the current entry. Can be taken from a domain.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point of time of the last change of the status</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">underLicence</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">validityRange</td>
| |
− | <td>String</td>
| |
− | <td>30</td>
| |
− | <td id="cardinality_cell">-</td>
| |
− | <td>Validity range, Values from domain list "codesystem_validityrange".
| |
− | Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td>
| |
| </tr> | | </tr> |
| <tr> | | <tr> |
Zeile 209: |
Zeile 58: |
| <td></td> <td id="cardinality_cell">1..1</td> | | <td></td> <td id="cardinality_cell">1..1</td> |
| <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> | | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">currentVersionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Current ID of code_system_entity_version.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">id</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td></td>
| |
| </tr> | | </tr> |
| <tr id="row_object"> | | <tr id="row_object"> |
Zeile 230: |
Zeile 65: |
| <td></td> <td id="cardinality_cell">1..1</td> | | <td></td> <td id="cardinality_cell">1..1</td> |
| <td>code_system_entity_version is the superclass of every Concept and Association. </td> | | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">codeSystemEntityId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Foreign key to code system entities ID</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">effectiveDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Last change date of the entity version.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">insertTimestamp</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point in time when entry was inserted.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">isLeaf</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td>
| |
| </tr> | | </tr> |
| <tr> | | <tr> |
Zeile 272: |
Zeile 79: |
| <td></td> <td id="cardinality_cell">0..1</td> | | <td></td> <td id="cardinality_cell">0..1</td> |
| <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> | | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">previousVersionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Refers to the prior version, if there are more than one version.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusDeactivated</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusDeactivatedDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Date when statusDeactivated changed</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusVisibility</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Status of the current entry. Can be taken from a domain.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusVisibilityDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point of time of the last change of the status.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusWorkflow</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>A workflow status, can be unique for each codesystem.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusWorkflowDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Date when statusWorkflow changed</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">versionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>The ID of this entry.</td>
| |
| </tr> | | </tr> |
| <tr id="row_object"> | | <tr id="row_object"> |
Zeile 335: |
Zeile 86: |
| <td></td> <td id="cardinality_cell">1..1</td> | | <td></td> <td id="cardinality_cell">1..1</td> |
| <td>Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version</td> | | <td>Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version</td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">4</td>
| |
− | <td id="param_level4">codeSystemEntityVersionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Match to the versionId of code_system_entity_version</td>
| |
| </tr> | | </tr> |
| <tr> | | <tr> |
Zeile 377: |
Zeile 121: |
| <td></td> <td id="cardinality_cell">1..1</td> | | <td></td> <td id="cardinality_cell">1..1</td> |
| <td>Return information</td> | | <td>Return information</td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">2</td>
| |
− | <td id="param_level2">count</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>number of results</td>
| |
| </tr> | | </tr> |
| <tr> | | <tr> |
Zeile 434: |
Zeile 171: |
| <td></td> <td id="cardinality_cell">1..1</td> | | <td></td> <td id="cardinality_cell">1..1</td> |
| <td>code_system_entity_version is the superclass of every Concept and Association. </td> | | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">codeSystemEntityId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Foreign key to code system entities ID</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">effectiveDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Last change date of the entity version.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">insertTimestamp</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point in time when entry was inserted.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">isLeaf</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">majorRevision</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">minorRevision</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">previousVersionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Refers to the prior version, if there are more than one version.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusDeactivated</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusDeactivatedDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Date when statusDeactivated changed</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusVisibility</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Status of the current entry. Can be taken from a domain.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusVisibilityDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Point of time of the last change of the status.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusWorkflow</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>A workflow status, can be unique for each codesystem.</td>
| |
− | </tr>
| |
− | <tr id="gray">
| |
− | <td id="cardinality_cell">3</td>
| |
− | <td id="param_level3">statusWorkflowDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">-</td>
| |
− | <td>Date when statusWorkflow changed</td>
| |
| </tr> | | </tr> |
| <tr> | | <tr> |
Create a new association type.
If a code system is specified, the new association type will be available in that code system only. Otherwise it will be available in all code systems.