...
| Property id | Formal def | Meaning | Correspondences | Translatable | Review comments |
|---|---|---|---|---|---|
| original_language | TERMINOLOGY_CODE [1] | ISO 639 code for the language in which the archetype was originally authored. | - | ||
| is_controlled | Boolean | - | |||
| provenance_id | UID | Id set at creation and thereafter never modified; serves as a handle on the artefact, no matter how it is changed over its lifetime | - | ||
| instance_id | UID | Id set and changed every single time the artefact is changed at the character level. | - | ||
| description.copyright | String | Copyright string | N | Move from translatable to non-translatable resource | |
| description.license | String | License text or license reference URL | N | Not only the copyright is important, but also the applicable license to the archetype. | |
| description.custodian_namespace | INTERNET_ID | Reverse internet domain of current custodian organisation | N | ||
| description.custodian_organisation | String | Human readable name of current custodian organisation | N | ||
| description.original_namespace | INTERNET_ID | Reverse internet domain of original publishing organisation | N | ||
| description.original_publisher | String | Human readable name of original publishing organisation | N | ||
| translations.language | TERMINOLOGY_CODE [1] | N | |||
| translations.author | Hash <String, String> | N | |||
| translations.accreditation | String | N | |||
| translations.other_details | N | ||||
| translations.version_last_translated | String | N | |||
| description.original_author | N | ||||
| description.other_contributors | N | ||||
| description.details.language | Main detailed description of archetype contents | Y | |||
| description.details.purpose | Y | ||||
| description.details.use | Y | ||||
| description.details.misuse | Y | ||||
| description.details.keywords | Y | ||||
| description.validation_date | String | Date of validation (not present if not validated) | N | TB: should be a registry item | |
| description.valid_until | String | Date when this archetype needs to be revised | N | TB: should be a registry item | |
| description.validator | String | Entity, Organization, or person who is responsible of the validity of the archetype | N | Maybe a better world for this field would be 'expeditor' TB: should be a registry item | |
| acknowledgements | Acknowledgements of 3rd party copyrights, trademarks etc. This probably should be in the form of the shortest possible text plus (reliable) URL references to pages containing the full text of each relevant statement, e.g. of the following form for each recognised trademark (using SNOMED CT as an example, and CIMI as an example publishing organisation):
If we did it this way, it would mean one String per 'acknowledgement'. If we need more, then the structure gets more complicated. Note that we want to absolutely minimise the text in the archetype to the minimum reliable text legally possible, and leave all other details to the referred-to page - because these details can change, and we don't want to have to revision hundreds or thousands of archetypes because e.g. IHTSDO decides to change its name (which apparently is quite likely in 2015). Things that need to be acknowledged include:
Normally this is just done by including text like 'copyright (c) Orgname' and 'xxxx(R)' to indicate recognition of the IP status. | N | |||
Registry Properties
...