OpenEHR Base package
0.1.0 - First Draft International flag

OpenEHR Base package, published by openEHR + HL7. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions

Logical Model: AUTHORED_RESOURCE - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the AUTHORED-RESOURCE logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. AUTHORED_RESOURCE
Definition

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


Base definition for all types defined in FHIR type system.

ShortAbstract idea of an online resource created by a human author.Base for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLanguages_available_valid: Languages available valid (languages_available().has (original_language))
Revision_history_valid: Revision history valid must satisfy exclusive conditions (is_controlled xor revision_history .empty())
Current_revision_valid: Current revision valid must be present ((current_revision().exists() and is_controlled.not()) implies current_revision().is_equal (“(uncontrolled)”))
Translations_valid: Translations valid must be present (translations.exists() implies (translations.empty().not() and translations.not().has (orginal_language.code_string)))
Description_valid: Description valid must be present (translations.exists() implies (description.details.for_all (d |\ntranslations.has_key (d.language.code_string))))
2. AUTHORED_RESOURCE.original-language
Definition

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.

ShortLanguage in which this resource was initially authored.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. AUTHORED_RESOURCE.is-controlled
Definition

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

ShortTrue if this resource is under any kind of change control (even file copying), in which case revision history is created.
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. AUTHORED_RESOURCE.translations
Definition

List of details for each natural-language translation made of this resource, keyed by language. 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.

ShortList of details for each natural-language translation made of this resource, keyed by language.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/TRANSLATION-DETAILS
Is Modifierfalse
8. AUTHORED_RESOURCE.description
Definition

Description and lifecycle information of the resource.

ShortDescription and lifecycle information of the resource.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/RESOURCE-DESCRIPTION
Is Modifierfalse
10. AUTHORED_RESOURCE.revision-history
Definition

The revision history of the resource. Only required if _is_controlled_ = True (avoids large revision histories for informal or private editing situations).

ShortThe revision history of the resource.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/REVISION-HISTORY
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. AUTHORED_RESOURCE
Definition

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

ShortAbstract idea of an online resource created by a human author.
Control0..*
BindingThe codes SHALL be taken from https://specifications.openehr.org/fhir/valueset-languages
(required to https://specifications.openehr.org/fhir/valueset-languages)
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLanguages_available_valid: Languages available valid (languages_available().has (original_language))
Revision_history_valid: Revision history valid must satisfy exclusive conditions (is_controlled xor revision_history .empty())
Current_revision_valid: Current revision valid must be present ((current_revision().exists() and is_controlled.not()) implies current_revision().is_equal (“(uncontrolled)”))
Translations_valid: Translations valid must be present (translations.exists() implies (translations.empty().not() and translations.not().has (orginal_language.code_string)))
Description_valid: Description valid must be present (translations.exists() implies (description.details.for_all (d |\ntranslations.has_key (d.language.code_string))))
2. AUTHORED_RESOURCE.original-language
Definition

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.

ShortLanguage in which this resource was initially authored.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. AUTHORED_RESOURCE.is-controlled
Definition

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

ShortTrue if this resource is under any kind of change control (even file copying), in which case revision history is created.
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. AUTHORED_RESOURCE.translations
Definition

List of details for each natural-language translation made of this resource, keyed by language. 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.

ShortList of details for each natural-language translation made of this resource, keyed by language.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/TRANSLATION-DETAILS
Is Modifierfalse
8. AUTHORED_RESOURCE.description
Definition

Description and lifecycle information of the resource.

ShortDescription and lifecycle information of the resource.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/RESOURCE-DESCRIPTION
Is Modifierfalse
10. AUTHORED_RESOURCE.revision-history
Definition

The revision history of the resource. Only required if _is_controlled_ = True (avoids large revision histories for informal or private editing situations).

ShortThe revision history of the resource.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/REVISION-HISTORY
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. AUTHORED_RESOURCE
Definition

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

ShortAbstract idea of an online resource created by a human author.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLanguages_available_valid: Languages available valid (languages_available().has (original_language))
Revision_history_valid: Revision history valid must satisfy exclusive conditions (is_controlled xor revision_history .empty())
Current_revision_valid: Current revision valid must be present ((current_revision().exists() and is_controlled.not()) implies current_revision().is_equal (“(uncontrolled)”))
Translations_valid: Translations valid must be present (translations.exists() implies (translations.empty().not() and translations.not().has (orginal_language.code_string)))
Description_valid: Description valid must be present (translations.exists() implies (description.details.for_all (d |\ntranslations.has_key (d.language.code_string))))
2. AUTHORED_RESOURCE.original-language
Definition

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.

ShortLanguage in which this resource was initially authored.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. AUTHORED_RESOURCE.is-controlled
Definition

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

ShortTrue if this resource is under any kind of change control (even file copying), in which case revision history is created.
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. AUTHORED_RESOURCE.translations
Definition

List of details for each natural-language translation made of this resource, keyed by language. 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.

ShortList of details for each natural-language translation made of this resource, keyed by language.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/TRANSLATION-DETAILS
Is Modifierfalse
8. AUTHORED_RESOURCE.description
Definition

Description and lifecycle information of the resource.

ShortDescription and lifecycle information of the resource.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/RESOURCE-DESCRIPTION
Is Modifierfalse
10. AUTHORED_RESOURCE.revision-history
Definition

The revision history of the resource. Only required if _is_controlled_ = True (avoids large revision histories for informal or private editing situations).

ShortThe revision history of the resource.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/REVISION-HISTORY
Is Modifierfalse