Versions Compared

Key

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

Table of Contents

Metadata

...


DescriptionExample
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 descriptionDefinition of the 'Concept name'. The intent of the definition is to define it as clinician's apply the concept 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."
PurposePreface 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.


MisusePreface 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.

...


DescriptionExample
<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.
Identification of 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.] 
Test name

Description: 
"Identification of the <test name> performed."

Comment: 
"Coding with an external terminology is preferred, where possible."

"Coding with an external terminology is optional."

Clinical descriptionAs per examination archetype pattern."Narrative description of the overall findings observed during the physical examination."
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 intepretation'> not captured in other fields."

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

Any event
"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 SLOTAdded 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 capture local content or to align with other reference models/formalisms."

Comment: 
"
For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents."

...