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: RESOURCE_DESCRIPTION - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the RESOURCE-DESCRIPTION logical model.

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

0. RESOURCE_DESCRIPTION
Definition

Defines the descriptive meta-data of a resource.


Base definition for all types defined in FHIR type system.

ShortDefines the descriptive meta-data of a resource.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
InvariantsOriginal_author_valid: Original author valid must not be empty (original_author.empty().not())
Lifecycle_state_valid: Lifecycle state valid must not be empty (lifecycle_state.empty().not())
Details_valid: Details valid must not be empty (details.empty().not())
Language_valid: Language valid must be present (parent_resource.exists() implies details.for_all (d | parent_resource.languages_available.has (d.language.code_string)))
Parent_resource_valid: Parent resource valid must be present (parent_resource.exists() implies parent_resource.description = self)
2. RESOURCE_DESCRIPTION.original-author
Definition

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

ShortOriginal author of this resource, with all relevant details, including organisation.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:string>
Is Modifierfalse
4. RESOURCE_DESCRIPTION.other-contributors
Definition

Other contributors to the resource, probably listed in 'name \<email>' form.

ShortOther contributors to the resource, probably listed in `'name <email>'` form.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. RESOURCE_DESCRIPTION.lifecycle-state
Definition

Lifecycle state of the resource, typically including states such as: initial | submitted | experimental | awaiting_approval | approved | superseded | obsolete.

ShortLifecycle state of the resource, typically including states such as: `initial | submitted | experimental | awaiting_approval | approved | superseded | obsolete`.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. RESOURCE_DESCRIPTION.resource-package-uri
Definition

URI of package to which this resource belongs.

ShortURI of package to which this resource belongs.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. RESOURCE_DESCRIPTION.other-details
Definition

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

ShortAdditional non language-senstive resource meta-data, as a list of name/value pairs.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:string>
Is Modifierfalse
12. RESOURCE_DESCRIPTION.parent-resource
Definition

Reference to owning resource.

ShortReference to owning resource.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/AUTHORED-RESOURCE
Is Modifierfalse
14. RESOURCE_DESCRIPTION.details
Definition

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

ShortDetails of all parts of resource description that are natural language-dependent, keyed by language code.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:http://openehr.org/fhir/StructureDefinition/RESOURCE-DESCRIPTION-ITEM>
Is Modifierfalse

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

0. RESOURCE_DESCRIPTION
Definition

Defines the descriptive meta-data of a resource.

ShortDefines the descriptive meta-data of a resource.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsOriginal_author_valid: Original author valid must not be empty (original_author.empty().not())
Lifecycle_state_valid: Lifecycle state valid must not be empty (lifecycle_state.empty().not())
Details_valid: Details valid must not be empty (details.empty().not())
Language_valid: Language valid must be present (parent_resource.exists() implies details.for_all (d | parent_resource.languages_available.has (d.language.code_string)))
Parent_resource_valid: Parent resource valid must be present (parent_resource.exists() implies parent_resource.description = self)
2. RESOURCE_DESCRIPTION.original-author
Definition

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

ShortOriginal author of this resource, with all relevant details, including organisation.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:string>
Is Modifierfalse
4. RESOURCE_DESCRIPTION.other-contributors
Definition

Other contributors to the resource, probably listed in 'name \<email>' form.

ShortOther contributors to the resource, probably listed in `'name <email>'` form.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. RESOURCE_DESCRIPTION.lifecycle-state
Definition

Lifecycle state of the resource, typically including states such as: initial | submitted | experimental | awaiting_approval | approved | superseded | obsolete.

ShortLifecycle state of the resource, typically including states such as: `initial | submitted | experimental | awaiting_approval | approved | superseded | obsolete`.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. RESOURCE_DESCRIPTION.resource-package-uri
Definition

URI of package to which this resource belongs.

ShortURI of package to which this resource belongs.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. RESOURCE_DESCRIPTION.other-details
Definition

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

ShortAdditional non language-senstive resource meta-data, as a list of name/value pairs.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:string>
Is Modifierfalse
12. RESOURCE_DESCRIPTION.parent-resource
Definition

Reference to owning resource.

ShortReference to owning resource.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/AUTHORED-RESOURCE
Is Modifierfalse
14. RESOURCE_DESCRIPTION.details
Definition

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

ShortDetails of all parts of resource description that are natural language-dependent, keyed by language code.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:http://openehr.org/fhir/StructureDefinition/RESOURCE-DESCRIPTION-ITEM>
Is Modifierfalse

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

0. RESOURCE_DESCRIPTION
Definition

Defines the descriptive meta-data of a resource.

ShortDefines the descriptive meta-data of a resource.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsOriginal_author_valid: Original author valid must not be empty (original_author.empty().not())
Lifecycle_state_valid: Lifecycle state valid must not be empty (lifecycle_state.empty().not())
Details_valid: Details valid must not be empty (details.empty().not())
Language_valid: Language valid must be present (parent_resource.exists() implies details.for_all (d | parent_resource.languages_available.has (d.language.code_string)))
Parent_resource_valid: Parent resource valid must be present (parent_resource.exists() implies parent_resource.description = self)
2. RESOURCE_DESCRIPTION.original-author
Definition

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

ShortOriginal author of this resource, with all relevant details, including organisation.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:string>
Is Modifierfalse
4. RESOURCE_DESCRIPTION.other-contributors
Definition

Other contributors to the resource, probably listed in 'name \<email>' form.

ShortOther contributors to the resource, probably listed in `'name <email>'` form.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. RESOURCE_DESCRIPTION.lifecycle-state
Definition

Lifecycle state of the resource, typically including states such as: initial | submitted | experimental | awaiting_approval | approved | superseded | obsolete.

ShortLifecycle state of the resource, typically including states such as: `initial | submitted | experimental | awaiting_approval | approved | superseded | obsolete`.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. RESOURCE_DESCRIPTION.resource-package-uri
Definition

URI of package to which this resource belongs.

ShortURI of package to which this resource belongs.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. RESOURCE_DESCRIPTION.other-details
Definition

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

ShortAdditional non language-senstive resource meta-data, as a list of name/value pairs.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:string>
Is Modifierfalse
12. RESOURCE_DESCRIPTION.parent-resource
Definition

Reference to owning resource.

ShortReference to owning resource.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/AUTHORED-RESOURCE
Is Modifierfalse
14. RESOURCE_DESCRIPTION.details
Definition

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

ShortDetails of all parts of resource description that are natural language-dependent, keyed by language code.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Hash<T:string; U:http://openehr.org/fhir/StructureDefinition/RESOURCE-DESCRIPTION-ITEM>
Is Modifierfalse