Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Focus

The Editorial focus in archetype design is primarily focused on ensuring that clinical content is expressed clearly and explicitly. Implementation and querying implications are always considered as critical components of archetype design but take a lower priority to representing clinical content accurately and in a way that clinicians can use and understand.

Original language

All archetypes for upload or federation to the international openEHR CKM should have English (ISO-639-1 "en") as the original language. All translations are done from the original language, and using any language less common than English will likely lead to "chinese whispers" translation; distortion of the original semantics through translations of translations.

...


Description

Example

Concept name

Succinct name that encompasses the scope and intent of the archetype.
Sentence case - with the first letter uppercase and subsequent letters lowercase. Exceptions include proper nouns or acronyms.

Blood pressure


INSTRUCTION archetype names will include the word 'order' or equivalent.

Corresponding ACTION archetype names will just contain the concept, or a very specific scope for the archetype.

INSTRUCTION: "Service request" & ACTION: "Service"

INSTRUCTION: "Medication order" & ACTION: "Medication management"

Concept description

Definition of the 'Concept name'. The intent of the description is to define the concept as clinicians apply it in clinical practice, not the academic or dictionary definition of the concept.

"The local measurement of arterial blood pressure which is a surrogate for arterial pressure in the systemic circulation."

Purpose

Preface with "To record "... or similar.


Use

  • Preface with "Use to record "... or similar. Ensure alignment with Purpose if appropriate.


  • If the archetype is designed to be used within a family of archetypes, include a statement about which archetypes are intended to be used within internal SLOTS or where the archetype may be nested within other archetypes.

"This archetype has been specifically designed to be used in the 'Examination detail' SLOT within the CLUSTER.exam-mouth, CLUSTER.exam-cranial_nerves or OBSERVATION.exam archetypes, but can also be used within other ENTRY or CLUSTER archetypes, where clinically appropriate."

  • Explain how SLOTs are intended to be used to expand the concept further.

'Use to provide a framework in which CLUSTER archetypes can be nested in the 'Examination findings' SLOT to record additional structured physical examination findings."

Misuse

Preface with "Not to be used"... or similar.


...

All data elements should be represented in Sentence case - with the first letter uppercase and subsequent letters lowercase. Exceptions include proper nouns or acronyms.

All descriptions should have a full stop or equivalent at the end of the description.

...


Description

Example

<XYZ> tested/examined

Usually mandatory, as if the actual object of the test or examination is not identified, then any subsequent data is not clearly identified.

The ear(s) to which the test stimulus is being presented.

  • Right ear [The test stimuli were presented to the right ear only.] or [The right ear was examined.]

  • Left ear [The test stimuli were presented to the left ear only.] or [The left ear was examined.]

  • Binaural [The test stimuli were presented to both ears simultaneously in a soundfield.] 

<XYZ> name

The name and/or code for a particular type of the real world concept the archetype is about. For example lab test, problem/diagnosis or medication.

The intent of the description is to describe the element concept as clinicians apply it in clinical practice, not the academic or dictionary definition of the concept.

Description:

The name of the <XYZ> <...>.

Comment: 

Coding with an external terminology is preferred, where possible.

Coding with an external terminology is optional.

Clinical description

As per examination archetype pattern.

Narrative description of the overall findings observed during the physical examination.

<XYZ> commenced

Naming of a data element used to describe a start date for an activity or a duration for an age commenced.


<XYZ> ceased

Naming of a data element used to describe a stop date for an activity or a duration for an age ceased.


Multimedia representation

SLOT to carry the CLUSTER.multimedia archetype until the data type is updated to support all of the additional requirements explicitly modelled in the archetype.

Digital image, video or diagram representing the findings.

Digital representation of the evidence of consent.

Comment

Last data element in many archetypes to catch data that may not yet be structured, nor fit into any other general narrative description data element.

May have multiple occurrences, if necessary.

Additional narrative about the <insert appropriate phrase here, for example ‘test results and interpretation’> not captured in other fields.

Additional narrative about the measurement of body weight, not captured in other fields.

Confounding factors


(Additional) Issues or factors that may impact on <the measurement of body temperature>, not captured in other fields.

Any event

As a default, “Any event” should have “0..*” occurrences, in order to have multiple recordings within one instance of the archetype.

Default, unspecified point in time or interval event which may be explicitly defined in a template or at run-time.

Any point in time event


Default, unspecified point in time event which may be explicitly defined in a template or at run-time.

Extension SLOT

Added to Protocol for every COMPOSITION or ENTRY archetype to allow for local extensions or potential alignment with other modelling paradigms.

Description:

Additional information required to extend the model with local content or to align with other reference models or formalisms.

Comment: 

For example: local information requirements; or additional metadata to align with FHIR.

ADL:

text = <"Extension">
description = <"Additional information required to extend the model with local content or to align with other reference models or formalisms.">
comment = <"For example: local information requirements; or additional metadata to align with FHIR.">

Partial dates and datetimes

Some date and datetime elements are intended to allow partial dates, for examples a year only. For these, a comment should be added to specify this.

Comment: 

Can be a partial date, for example, only a year.

...