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.
...
Description | Example | |
---|---|---|
Concept name | Succinct name that encompasses the scope and intent of the archetype. | 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" | |
When there is an abbreviation within the name of the archetype, the abbreviation should occur right after the words of which the abbreviation is made. | “Neurologic Assessment in Neuro-Oncology (NANO) scale.”, and not “Neurologic Assessment in Neuro-Oncology scale (NANO).” | |
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. | COMPOSITION wording needs to be a little different to other clinical content - for example ”a named container for information provided by an individual, to support clear separation of patient generated from clinically genereated health data.” |
Use |
| “Use to record all representations of systemic arterial blood pressure measurement, no matter which method or body location is used to record it.” |
| "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." | |
| '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. | “Not to be used to record measurements of intravenous pressure. Use the appropriate specialisations of OBSERVATION.intravascular_pressure in this situation.” |
...
SNOMED-CT | Until tooling evolves to allow this to occur through a standard interface, add manually via Notepad or equivalent directly to "other_details = <" section in the archetype ADL:
|
---|
Data elements
All data
...
element names should be represented in Sentence case - with the first letter uppercase and subsequent letters lowercase. Exceptions include proper nouns or acronyms.
All data element descriptions should have a full stop or equivalent at the end of the description.
Examples and other further explanations about how to use a specific data element should be noted in the “Comment” section of the data element. Use wording like “For example: [example 1]; [example 2]; or [example 3].”
CKM will flag a style error on upload if the data element has extra spaces at the beginning or end of a sentence, or if the description does not end with a full stop or equivalent.
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.
| |
<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:
Comment:
| |
Clinical description | As per examination archetype pattern. |
| |
<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. |
| |
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. |
| |
Confounding factors |
| ||
Any event | As a default, “Any event” should have “0..*” occurrences, in order to have multiple recordings within one instance of the archetype. |
| |
Any point in time event |
| ||
Extension SLOT | Added to Protocol for every COMPOSITION or ENTRY archetype to allow for local extensions or potential alignment with other modelling paradigms. | Description:
Comment:
ADL:
| |
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:
| |
Body sites | The recording of body sites is normally modelled as the combination of a Text element named “Body site” and a SLOT named “Structured body site” for a CLUSTER archetype. The SLOT should normally include one or more of CLUSTER.anatomical_location, CLUSTER.anatomical_location_circle, or CLUSTER.anatomical_location_relative. | Name:
Description:
Comment:
|
...