Archetype content

Metadata

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

CKM will flag a style error on upload if the text has extra spaces at the beginning or end of a sentence, or if the text does not end with a full stop or equivalent.

	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 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."
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.
Misuse	Preface with "Not to be used"... or similar.

References


References within published archetypes should be consistent with Citing Medicine, 2nd edition - The NLM Style Guide for Authors, Editors, and Publishers	https://www.ncbi.nlm.nih.gov/books/NBK7256/?amp=&depth=2.
The National Library of Medicine provides an easy way to ensure consistent formatting through the use of a bibliography tool that can automatically configure citations for a variety of different publications. If the required citation is not found within the PubMed search then the link above will support manual formatting, eg for parts of websites.	https://www.ncbi.nlm.nih.gov/sites/myncbi/
References to other archetypes or parts of archetypes within CKM can be located on the 'Share with Colleague' tab for each archetype.	http://www.openehr.org/ckm/#showArchetype_1013.1.2741_SHAREWITHCOLLEAGUE

IP Acknowledgement

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:
["ip_acknowledgements"] = <"This artefact includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyrighted material of the International Health Terminology Standards Development Organisation (IHTSDO). Where an implementation of this artefact makes use of SNOMED CT content, the implementer must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/get-snomedct or info@snomed.org.">

Data elements

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.

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.	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 description	As 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 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 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."