Resource Package

Overview

The openEHR BASE component resource package defines the structure and semantics of the general notion of an online resource which has been created by a human author, and consequently for which natural language is a factor. The package is illustrated below.

BASE resource
Figure 1. resource Package

Natural Languages and Translation

Authored resources contain natural language elements, and are therefore created in some original language, recorded in the orginal_language attribute of the AUTHORED_RESOURCE class. Information about translations is included in the translations attribute, which allows for one or more sets of translation details to be recorded. A resource is translated by doing the following:

  • translating every language-dependent element to the new language;

  • adding a new TRANSLATION_DETAILS instance to translations, containing details about the translator, organisation, quality assurance and so on.

  • any further translations to language-specific elements in instances of descendent type of AUTHORED_RESOURCE.

The languages_available function provides a complete list of languages in the resource.

Meta-data

What is normally considered the 'meta-data' of a resource, i.e. its author, date of creation, purpose, and other descriptive items, is described by the RESOURCE_DESCRIPTION and RESOURCE_DESCRIPTION_ITEM classes. The parts of this that are in natural language, and therefore may require translated versions, are represented in instances of the RESOURCE_DESCRIPTION_ITEM class. Thus, if a RESOURCE_DESCRIPTION has more than one RESOURCE_DESCRIPTION_ITEM, each of these should carry exactly the same information in a different natural language.

The AUTHORED_RESOURCE.description attribute is optional, allowing for resources with no meta-data at all, e.g. resources in a partial state of construction. The translations attribute may still be required, since there may be other parts of the resource object (specified by a class into which AUTHORED_RESOURCE is inherited) that are language-dependent.

Revision History

When the resource is considered to be in a state where changes to it should be controlled, the is_controlled attribute is set to True, and all subsequent changes should have an audit trail recorded. Usually controlled resources would be managed in a versioned repository (e.g. implemented by a Git, Subversion or similar systems), and audit information will be stored somewhere in the repository (e.g. in version control files).

Class Descriptions

AUTHORED_RESOURCE Class

  • Definition

  • Effective

  • BMM

  • UML

Class

AUTHORED_RESOURCE (abstract)

Description

Abstract idea of an online resource created by a human author.

Attributes

Signature

Meaning

0..1

uid: UUID

Unique identifier of the family of archetypes having the same interface identifier (same major version).

1..1

original_language: Terminology_code

Language in which this resource was initially authored. Although there is no language primacy of resources overall, the language of original authoring is required to ensure natural language translations can preserve quality. Language is relevant in both the description and ontology sections.

0..1

description: RESOURCE_DESCRIPTION

Description and lifecycle information of the resource.

0..1

is_controlled: Boolean

True if this resource is under any kind of change control (even file copying), in which case revision history is created.

0..1

annotations: RESOURCE_ANNOTATIONS

Annotations on individual items within the resource, keyed by path. The inner table takes the form of a Hash table of String values keyed by String tags.

0..1

translations: Hash<Any,TRANSLATION_DETAILS>

List of details for each natural translation made of this resource, keyed by language code. For each translation listed here, there must be corresponding sections in all language-dependent parts of the resource. The original_language does not appear in this list.

Functions

Signature

Meaning

1..1

current_revision (): String

Post: Result = revision_history.most_recent_version

Most recent revision in revision_history if is_controlled else (uncontrolled) .

1..1

languages_available (): List<String>

Total list of languages available in this resource, derived from original_language and translations.

Invariants

Original_language_valid: code_set (Code_set_id_languages).has_code (original_language.as_string)

Current_revision_valid: (current_revision /= Void and not is_controlled) implies current_revision.is_equal ("(uncontrolled)")

Translations_valid: translations /= Void implies (not translations.is_empty and not translations.has (orginal_language.code_string))

Description_valid: translations /= Void implies (description.details.for_all (d | translations.has_key (d.language.code_string)))

Languages_available_valid: languages_available.has (original_language)

Revision_history_valid: is_controlled xor revision_history = Void
AUTHORED_RESOURCE (abstract)

Abstract idea of an online resource created by a human author.

Attributes

uid: UUID [0..1]

Unique identifier of the family of archetypes having the same interface identifier (same major version).

original_language: Terminology_code [1..1]

Language in which this resource was initially authored. Although there is no language primacy of resources overall, the language of original authoring is required to ensure natural language translations can preserve quality. Language is relevant in both the description and ontology sections.

description: RESOURCE_DESCRIPTION [0..1]

Description and lifecycle information of the resource.

is_controlled: Boolean [0..1]

True if this resource is under any kind of change control (even file copying), in which case revision history is created.

annotations: RESOURCE_ANNOTATIONS [0..1]

Annotations on individual items within the resource, keyed by path. The inner table takes the form of a Hash table of String values keyed by String tags.

translations: Hash<Any,TRANSLATION_DETAILS> [0..1]

List of details for each natural translation made of this resource, keyed by language code. For each translation listed here, there must be corresponding sections in all language-dependent parts of the resource. The original_language does not appear in this list.

Functions

current_revision (): String

Post: Result = revision_history.most_recent_version [1..1]

Most recent revision in revision_history if is_controlled else (uncontrolled) .

languages_available (): List<String> [1..1]

Total list of languages available in this resource, derived from original_language and translations.

Invariants

Original_language_valid: code_set (Code_set_id_languages).has_code (original_language.as_string)

Current_revision_valid: (current_revision /= Void and not is_controlled) implies current_revision.is_equal ("(uncontrolled)")

Translations_valid: translations /= Void implies (not translations.is_empty and not translations.has (orginal_language.code_string))

Description_valid: translations /= Void implies (description.details.for_all (d | translations.has_key (d.language.code_string)))

Languages_available_valid: languages_available.has (original_language)

Revision_history_valid: is_controlled xor revision_history = Void

 
{
    "name": "AUTHORED_RESOURCE",
    "documentation": "Abstract idea of an online resource created by a human author. \n",
    "is_abstract": true,
    "properties": {
        "uid": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "uid",
            "documentation": "Unique identifier of the family of archetypes having the same interface identifier (same major version).",
            "type": "UUID"
        },
        "original_language": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "original_language",
            "documentation": "Language in which this resource was initially authored. Although there is no language primacy of resources overall, the language of original authoring is required to ensure natural language translations can preserve quality. Language is relevant in both the description and ontology sections. ",
            "is_mandatory": true,
            "type": "Terminology_code"
        },
        "description": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "description",
            "documentation": "Description and lifecycle information of the resource.",
            "type": "RESOURCE_DESCRIPTION"
        },
        "is_controlled": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "is_controlled",
            "documentation": "True if this resource is under any kind of change control (even file copying), in which case revision history is created. ",
            "type": "Boolean"
        },
        "annotations": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "annotations",
            "documentation": "Annotations on individual items within the resource, keyed by path. The inner table takes the form of a Hash table of String values keyed by String tags.",
            "type": "RESOURCE_ANNOTATIONS"
        },
        "translations": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "translations",
            "documentation": "List of details for each natural translation made of this resource, keyed by language code. For each translation listed here, there must be corresponding sections in all language-dependent parts of the resource. The `_original_language_` does not appear in this list.",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "Any",
                    "TRANSLATION_DETAILS"
                ]
            }
        }
    },
    "functions": {
        "current_revision": {
            "name": "current_revision",
            "documentation": "Most recent revision in revision_history if is_controlled else  (uncontrolled) . ",
            "post_conditions": {
                "Post": "Result = revision_history.most_recent_version"
            },
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "String"
            }
        },
        "languages_available": {
            "name": "languages_available",
            "documentation": "Total list of languages available in this resource, derived from original_language and translations. ",
            "result": {
                "_type": "P_BMM_CONTAINER_TYPE",
                "container_type": "List",
                "type": "String"
            }
        }
    },
    "invariants": {
        "Original_language_valid": "code_set (Code_set_id_languages).has_code (original_language.as_string)",
        "Current_revision_valid": "(current_revision /= Void and not is_controlled) implies current_revision.is_equal (\"(uncontrolled)\")",
        "Translations_valid": "translations /= Void implies (not translations.is_empty and not translations.has (orginal_language.code_string))",
        "Description_valid": "translations /= Void implies (description.details.for_all (d &#124;\ntranslations.has_key (d.language.code_string)))",
        "Languages_available_valid": "languages_available.has (original_language)",
        "Revision_history_valid": "is_controlled xor revision_history = Void"
    }
}
AUTHORED_RESOURCE

TRANSLATION_DETAILS Class

  • Definition

  • Effective

  • BMM

  • UML

Class

TRANSLATION_DETAILS

Description

Class providing details of a natural language translation.

Attributes

Signature

Meaning

1..1

language: Terminology_code

Language of the translation, coded using ISO 639-1 (2 character) language codes.

1..1

author: Hash<String,String>

Primary translator name and other demographic details.

0..1

accreditation: String

Accreditation of primary translator or group, usually a national translator’s registration or association membership id.

0..1

other_details: Hash<String,String>

Any other meta-data.

0..1

version_last_translated: String

Version of this resource last time it was translated into the language represented by this TRANSLATION_DETAILS object.

0..1

other_contributors: List<String>

Additional contributors to this translation, each listed in the preferred format of the relevant organisation for the artefacts in question. A typical default is "name <email>" if nothing else is specified.
TRANSLATION_DETAILS

Class providing details of a natural language translation.

Attributes

language: Terminology_code [1..1]

Language of the translation, coded using ISO 639-1 (2 character) language codes.

author: Hash<String,String> [1..1]

Primary translator name and other demographic details.

accreditation: String [0..1]

Accreditation of primary translator or group, usually a national translator’s registration or association membership id.

other_details: Hash<String,String> [0..1]

Any other meta-data.

version_last_translated: String [0..1]

Version of this resource last time it was translated into the language represented by this TRANSLATION_DETAILS object.

other_contributors: List<String> [0..1]

Additional contributors to this translation, each listed in the preferred format of the relevant organisation for the artefacts in question. A typical default is "name <email>" if nothing else is specified.

 
{
    "name": "TRANSLATION_DETAILS",
    "documentation": "Class providing details of a natural language translation.",
    "properties": {
        "language": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "language",
            "documentation": "Language of the translation, coded using ISO 639-1 (2 character) language codes.",
            "is_mandatory": true,
            "type": "Terminology_code"
        },
        "author": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "author",
            "documentation": "Primary translator name and other demographic details.",
            "is_mandatory": true,
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        },
        "accreditation": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "accreditation",
            "documentation": "Accreditation of primary translator or group, usually a national translator's registration or association membership id.",
            "type": "String"
        },
        "other_details": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "other_details",
            "documentation": "Any other meta-data.",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        },
        "version_last_translated": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "version_last_translated",
            "documentation": "Version of this resource last time it was translated into the language represented by this `TRANSLATION_DETAILS` object.",
            "type": "String"
        },
        "other_contributors": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "other_contributors",
            "documentation": "Additional contributors to this translation, each listed in the preferred format of the relevant organisation for the artefacts in question. A typical default is `\"name <email>\"` if nothing else is specified. ",
            "type_def": {
                "container_type": "List",
                "type": "String"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        }
    }
}
TRANSLATION_DETAILS

RESOURCE_DESCRIPTION Class

  • Definition

  • Effective

  • BMM

  • UML

Class

RESOURCE_DESCRIPTION

Description

Defines the descriptive meta-data of a resource.

Attributes

Signature

Meaning

0..1

title: String

Long-form descriptive title of the resource, typically needed in templates and occasionally in specialised archetypes where the root archetype/template name is not descriptive enough to disambiguate from similar archetypes/templates.

1..1

original_author: Hash<String,String>

Original author of this resource, with all relevant details, including organisation.

0..1

original_namespace: String

Namespace of original author’s organisation, in reverse internet form, if applicable.

0..1

original_publisher: String

Plain text name of organisation that originally published this artefact, if any.

0..1

other_contributors: List<String>

Other contributors to the resource, each listed in "name <email>" form.

1..1

parent_resource: AUTHORED_RESOURCE
{default = }

Reference to owning resource.

1..1

lifecycle_state: String

Lifecycle state of the resource, typically including states such as: initial, in_development, in_review, published, superseded, obsolete.

0..1

custodian_namespace: String

Namespace in reverse internet id form, of current custodian organisation.

0..1

custodian_organisation: String

Plain text name of current custodian organisation.

0..1

copyright: String

Optional copyright statement for the resource as a knowledge resource.

0..1

licence: String

Licence of current artefact, in format "short licence name <URL of licence>", e.g. "Apache 2.0 License http://www.apache.org/licenses/LICENSE-2.0.html"

0..1

ip_acknowledgements: Hash<String,String>

List of acknowledgements of other IP directly referenced in this archetype, typically terminology codes, ontology ids etc. Recommended keys are the widely known name or namespace for the IP source, as shown in the following example:

ip_acknowledgements = <
    ["loinc"] = <"This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use">
    ["snomedct"] = <"Content from SNOMED CT® is copyright © 2007 IHTSDO <ihtsdo.org>">
>

0..1

references: Hash<String,String>

List of references of material on which this artefact is based, as a keyed list of strings. The keys should be in a standard citation format.

0..1

resource_package_uri: String

URI of package to which this resource belongs.

0..1

conversion_details: Hash<String,String>

Details related to conversion process that generated this model from an original, if relevant, as a list of name/value pairs. Typical example with recommended tags:

conversion_details = <
    ["source_model"] = <"CEM model xyz <http://location.in.clinicalelementmodels.com>">
    ["tool"] = <"cem2adl v6.3.0">
    ["time"] = <"2014-11-03T09:05:00">
>

0..1

details: Hash<Any,RESOURCE_DESCRIPTION_ITEM>

Details of all parts of resource description that are natural language-dependent, keyed by language code.

0..1

other_details: Hash<String,String>

Additional non-language-sensitive resource meta-data, as a list of name/value pairs.
RESOURCE_DESCRIPTION

Defines the descriptive meta-data of a resource.

Attributes

title: String [0..1]

Long-form descriptive title of the resource, typically needed in templates and occasionally in specialised archetypes where the root archetype/template name is not descriptive enough to disambiguate from similar archetypes/templates.

original_author: Hash<String,String> [1..1]

Original author of this resource, with all relevant details, including organisation.

original_namespace: String [0..1]

Namespace of original author’s organisation, in reverse internet form, if applicable.

original_publisher: String [0..1]

Plain text name of organisation that originally published this artefact, if any.

other_contributors: List<String> [0..1]

Other contributors to the resource, each listed in "name <email>" form.

parent_resource: AUTHORED_RESOURCE [1..1]
{default = }

Reference to owning resource.

lifecycle_state: String [1..1]

Lifecycle state of the resource, typically including states such as: initial, in_development, in_review, published, superseded, obsolete.

custodian_namespace: String [0..1]

Namespace in reverse internet id form, of current custodian organisation.

custodian_organisation: String [0..1]

Plain text name of current custodian organisation.

copyright: String [0..1]

Optional copyright statement for the resource as a knowledge resource.

licence: String [0..1]

Licence of current artefact, in format "short licence name <URL of licence>", e.g. "Apache 2.0 License http://www.apache.org/licenses/LICENSE-2.0.html"

ip_acknowledgements: Hash<String,String> [0..1]

List of acknowledgements of other IP directly referenced in this archetype, typically terminology codes, ontology ids etc. Recommended keys are the widely known name or namespace for the IP source, as shown in the following example:

ip_acknowledgements = <
    ["loinc"] = <"This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use">
    ["snomedct"] = <"Content from SNOMED CT® is copyright © 2007 IHTSDO <ihtsdo.org>">
>

references: Hash<String,String> [0..1]

List of references of material on which this artefact is based, as a keyed list of strings. The keys should be in a standard citation format.

resource_package_uri: String [0..1]

URI of package to which this resource belongs.

conversion_details: Hash<String,String> [0..1]

Details related to conversion process that generated this model from an original, if relevant, as a list of name/value pairs. Typical example with recommended tags:

conversion_details = <
    ["source_model"] = <"CEM model xyz <http://location.in.clinicalelementmodels.com>">
    ["tool"] = <"cem2adl v6.3.0">
    ["time"] = <"2014-11-03T09:05:00">
>

details: Hash<Any,RESOURCE_DESCRIPTION_ITEM> [0..1]

Details of all parts of resource description that are natural language-dependent, keyed by language code.

other_details: Hash<String,String> [0..1]

Additional non-language-sensitive resource meta-data, as a list of name/value pairs.

 
{
    "name": "RESOURCE_DESCRIPTION",
    "documentation": "Defines the descriptive meta-data of a resource.",
    "properties": {
        "title": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "title",
            "documentation": "Long-form descriptive title of the resource, typically needed in templates and occasionally in specialised archetypes where the root archetype/template name is not descriptive enough to disambiguate from similar archetypes/templates.\n",
            "type": "String"
        },
        "original_author": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "original_author",
            "documentation": "Original author of this resource, with all relevant details, including organisation.",
            "is_mandatory": true,
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        },
        "original_namespace": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "original_namespace",
            "documentation": "Namespace of original author's organisation, in reverse internet form, if applicable.",
            "type": "String"
        },
        "original_publisher": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "original_publisher",
            "documentation": "Plain text name of organisation that originally published this artefact, if any.",
            "type": "String"
        },
        "other_contributors": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "other_contributors",
            "documentation": "Other contributors to the resource, each listed in \"name <email>\"  form. ",
            "type_def": {
                "container_type": "List",
                "type": "String"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        },
        "parent_resource": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "parent_resource",
            "documentation": "Reference to owning resource. ",
            "is_mandatory": true,
            "type": "AUTHORED_RESOURCE",
            "default": ""
        },
        "lifecycle_state": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "lifecycle_state",
            "documentation": "Lifecycle state of the resource, typically including states such as: initial, in_development, in_review, published, superseded, obsolete. ",
            "is_mandatory": true,
            "type": "String"
        },
        "custodian_namespace": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "custodian_namespace",
            "documentation": "Namespace in reverse internet id form, of current custodian organisation.",
            "type": "String"
        },
        "custodian_organisation": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "custodian_organisation",
            "documentation": "Plain text name of current custodian organisation.",
            "type": "String"
        },
        "copyright": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "copyright",
            "documentation": "Optional copyright statement for the resource as a knowledge resource. \n",
            "type": "String"
        },
        "licence": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "licence",
            "documentation": "Licence of current artefact, in format \"short licence name <URL of licence>\", e.g. \"Apache 2.0 License <http://www.apache.org/licenses/LICENSE-2.0.html>\"",
            "type": "String"
        },
        "ip_acknowledgements": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "ip_acknowledgements",
            "documentation": "List of acknowledgements of other IP directly referenced in this archetype, typically terminology codes, ontology ids etc. Recommended keys are the widely known name or namespace for the IP source, as shown in the following example:\n\n----\nip_acknowledgements = <\n    [\"loinc\"] = <\"This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use\">\n    [\"snomedct\"] = <\"Content from SNOMED CT® is copyright © 2007 IHTSDO <ihtsdo.org>\">\n>\n----",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        },
        "references": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "references",
            "documentation": "List of references of material on which this artefact is based, as a keyed list of strings. The keys should be in a standard citation format.",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        },
        "resource_package_uri": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "resource_package_uri",
            "documentation": "URI of package to which this resource belongs.",
            "type": "String"
        },
        "conversion_details": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "conversion_details",
            "documentation": "Details related to conversion process that generated this model from an original, if relevant, as a list of name/value pairs. Typical example with recommended tags:\n\n----\nconversion_details = <\n    [\"source_model\"] = <\"CEM model xyz <http://location.in.clinicalelementmodels.com>\">\n    [\"tool\"] = <\"cem2adl v6.3.0\">\n    [\"time\"] = <\"2014-11-03T09:05:00\">\n>\n----",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        },
        "details": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "details",
            "documentation": "Details of all parts of resource description that are natural language-dependent, keyed by language code.",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "Any",
                    "RESOURCE_DESCRIPTION_ITEM"
                ]
            }
        },
        "other_details": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "other_details",
            "documentation": "Additional non-language-sensitive resource meta-data, as a list of name/value pairs.",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        }
    }
}
RESOURCE_DESCRIPTION

RESOURCE_DESCRIPTION_ITEM Class

  • Definition

  • Effective

  • BMM

  • UML

Class

RESOURCE_DESCRIPTION_ITEM

Description

Language-specific detail of resource description. When a resource is translated for use in another language environment, each RESOURCE_DESCRIPTION_ITEM needs to be copied and translated into the new language.

Attributes

Signature

Meaning

1..1

language: Terminology_code

The localised language in which the items in this description item are written. Coded using ISO 639-1 (2 character) language codes.

1..1

purpose: String

Purpose of the resource.

0..1

keywords: List<String>

Keywords which characterise this resource, used e.g. for indexing and searching.

0..1

use: String

Description of the uses of the resource, i.e. contexts in which it could be used.

0..1

misuse: String

Description of any misuses of the resource, i.e. contexts in which it should not be used.

0..1

original_resource_uri: Hash<String,String>

URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.

0..1

other_details: Hash<String,String>

Additional language-senstive resource metadata, as a list of name/value pairs.
RESOURCE_DESCRIPTION_ITEM

Language-specific detail of resource description. When a resource is translated for use in another language environment, each RESOURCE_DESCRIPTION_ITEM needs to be copied and translated into the new language.

Attributes

language: Terminology_code [1..1]

The localised language in which the items in this description item are written. Coded using ISO 639-1 (2 character) language codes.

purpose: String [1..1]

Purpose of the resource.

keywords: List<String> [0..1]

Keywords which characterise this resource, used e.g. for indexing and searching.

use: String [0..1]

Description of the uses of the resource, i.e. contexts in which it could be used.

misuse: String [0..1]

Description of any misuses of the resource, i.e. contexts in which it should not be used.

original_resource_uri: Hash<String,String> [0..1]

URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.

other_details: Hash<String,String> [0..1]

Additional language-senstive resource metadata, as a list of name/value pairs.

 
{
    "name": "RESOURCE_DESCRIPTION_ITEM",
    "documentation": "Language-specific detail of resource description. When a resource is translated for use in another language environment, each `RESOURCE_DESCRIPTION_ITEM` needs to be copied and translated into the new language.",
    "properties": {
        "language": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "language",
            "documentation": "The localised language in which the items in this description item are written. Coded using ISO 639-1 (2 character) language codes.",
            "is_mandatory": true,
            "type": "Terminology_code"
        },
        "purpose": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "purpose",
            "documentation": "Purpose of the resource.",
            "is_mandatory": true,
            "type": "String"
        },
        "keywords": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "keywords",
            "documentation": "Keywords which characterise this resource, used e.g. for indexing and searching. \n",
            "type_def": {
                "container_type": "List",
                "type": "String"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        },
        "use": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "use",
            "documentation": "Description of the uses of the resource, i.e. contexts in which it could be used. \n",
            "type": "String"
        },
        "misuse": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "misuse",
            "documentation": "Description of any misuses of the resource, i.e. contexts in which it should not be used.",
            "type": "String"
        },
        "original_resource_uri": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "original_resource_uri",
            "documentation": "URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        },
        "other_details": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "other_details",
            "documentation": "Additional language-senstive resource metadata, as a list of name/value pairs. ",
            "type_def": {
                "root_type": "Hash",
                "generic_parameters": [
                    "String",
                    "String"
                ]
            }
        }
    }
}
RESOURCE_DESCRIPTION_ITEM

RESOURCE_ANNOTATIONS Class

  • Definition

  • Effective

  • BMM

  • UML

Class

RESOURCE_ANNOTATIONS

Description

Object representing annotations on an archetype. These can be of various forms, with a documentation form defined so far, which has a multi-level tabular structure [ [ [String value, String key], path key], language key]. Example instance, showing the documentation structure.

    documentation = <
        ["en"] = <
           ["/data[id2]"] = <
               ["ui"] = <"passthrough">
           >
           ["/data[id2]/items[id3]"] = <
               ["design note"] = <"this is a design note on Statement">
               ["requirements note"] = <"this is a requirements note on Statement">
               ["medline ref"] = <"this is a medline ref on Statement">
           >
        >
    >

Other sub-structures might have different keys, e.g. based on programming languages, UI toolkits etc.

Attributes

Signature

Meaning

1..1

documentation: Hash<String,Hash<String,Hash<String,String>>>

Documentary annotations in a multi-level keyed structure.
RESOURCE_ANNOTATIONS

Object representing annotations on an archetype. These can be of various forms, with a documentation form defined so far, which has a multi-level tabular structure [ [ [String value, String key], path key], language key]. Example instance, showing the documentation structure.

    documentation = <
        ["en"] = <
           ["/data[id2]"] = <
               ["ui"] = <"passthrough">
           >
           ["/data[id2]/items[id3]"] = <
               ["design note"] = <"this is a design note on Statement">
               ["requirements note"] = <"this is a requirements note on Statement">
               ["medline ref"] = <"this is a medline ref on Statement">
           >
        >
    >

Other sub-structures might have different keys, e.g. based on programming languages, UI toolkits etc.

Attributes

documentation: Hash<String,Hash<String,Hash<String,String>>> [1..1]

Documentary annotations in a multi-level keyed structure.

 
{
    "name": "RESOURCE_ANNOTATIONS",
    "documentation": "Object representing annotations on an archetype. These can be of various forms, with a documentation form defined so far, which has a multi-level tabular structure [ [ [String value, String key], path key], language key]. Example instance, showing the documentation structure.\n\n--------\n    documentation = <\n        [\"en\"] = <\n           [\"/data[id2]\"] = <\n               [\"ui\"] = <\"passthrough\">\n           >\n           [\"/data[id2]/items[id3]\"] = <\n               [\"design note\"] = <\"this is a design note on Statement\">\n               [\"requirements note\"] = <\"this is a requirements note on Statement\">\n               [\"medline ref\"] = <\"this is a medline ref on Statement\">\n           >\n        >\n    >\n--------\n\nOther sub-structures might have different keys, e.g.  based on programming languages, UI toolkits etc.\n",
    "properties": {
        "documentation": {
            "_type": "P_BMM_GENERIC_PROPERTY",
            "name": "documentation",
            "documentation": "Documentary annotations in a multi-level keyed structure.",
            "is_mandatory": true,
            "type_def": {
                "root_type": "Hash",
                "generic_parameter_defs": {
                    "K": {
                        "_type": "P_BMM_SIMPLE_TYPE",
                        "type": "String"
                    },
                    "V": {
                        "_type": "P_BMM_GENERIC_TYPE",
                        "root_type": "Hash",
                        "generic_parameter_defs": {
                            "K": {
                                "_type": "P_BMM_SIMPLE_TYPE",
                                "type": "String"
                            },
                            "V": {
                                "_type": "P_BMM_GENERIC_TYPE",
                                "root_type": "Hash",
                                "generic_parameters": [
                                    "String",
                                    "String"
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}
RESOURCE_ANNOTATIONS