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

Page standards status: Informative Maturity Level: 3

Definitions for the CODE-PHRASE logical model.

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

0. CODE_PHRASE
Definition

A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).


Base definition for all types defined in FHIR type system.

ShortA fully coordinated (i.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
InvariantsCode_string_valid: Code string valid must not be empty (code_string.empty().not())
2. CODE_PHRASE.terminology-id
Definition

Identifier of the distinct terminology from which the code_string (or its elements) was extracted.

ShortIdentifier of the distinct terminology from which the code_string (or its elements) was extracted.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/TERMINOLOGY-ID
Is Modifierfalse
4. CODE_PHRASE.code-string
Definition

The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

ShortThe key used by the terminology service to identify a concept or coordination of concepts.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CODE_PHRASE.preferred-term
Definition

Optional attribute to carry preferred term corresponding to the code or expression in _code_string_. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

ShortOptional attribute to carry preferred term corresponding to the code or expression in `_code_string_`.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. CODE_PHRASE
Definition

A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).

ShortA fully coordinated (i.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsCode_string_valid: Code string valid must not be empty (code_string.empty().not())
2. CODE_PHRASE.terminology-id
Definition

Identifier of the distinct terminology from which the code_string (or its elements) was extracted.

ShortIdentifier of the distinct terminology from which the code_string (or its elements) was extracted.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/TERMINOLOGY-ID
Is Modifierfalse
4. CODE_PHRASE.code-string
Definition

The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

ShortThe key used by the terminology service to identify a concept or coordination of concepts.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CODE_PHRASE.preferred-term
Definition

Optional attribute to carry preferred term corresponding to the code or expression in _code_string_. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

ShortOptional attribute to carry preferred term corresponding to the code or expression in `_code_string_`.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. CODE_PHRASE
Definition

A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).

ShortA fully coordinated (i.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsCode_string_valid: Code string valid must not be empty (code_string.empty().not())
2. CODE_PHRASE.terminology-id
Definition

Identifier of the distinct terminology from which the code_string (or its elements) was extracted.

ShortIdentifier of the distinct terminology from which the code_string (or its elements) was extracted.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/TERMINOLOGY-ID
Is Modifierfalse
4. CODE_PHRASE.code-string
Definition

The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

ShortThe key used by the terminology service to identify a concept or coordination of concepts.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CODE_PHRASE.preferred-term
Definition

Optional attribute to carry preferred term corresponding to the code or expression in _code_string_. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

ShortOptional attribute to carry preferred term corresponding to the code or expression in `_code_string_`.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension