SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. 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/savannahghi/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

Data Type Profile: SGHIAnnotation - Detailed Descriptions

Draft as of 2025-09-04

Definitions for the sghi-annotation data type profile.

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

0. Annotation
Definition

A text note which also contains information about who made the statement and when.

ShortText node with attribution
Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Control0..*
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Annotation.author[x]
Definition

The individual responsible for making the annotation.

ShortIndividual responsible for the annotation
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Control0..1
TypeChoice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Annotation.author[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 4. Annotation.author[x]:authorReference
    Slice NameauthorReference
    Definition

    The individual responsible for making the annotation.

    ShortIndividual responsible for the annotation
    Comments

    Organization is used when there's no need for specific attribution as to who made the comment.

    Control0..1
    TypeReference(SGHI Reference)(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. Annotation.time
    Definition

    Indicates when this particular annotation was made.

    ShortWhen the annotation was made
    Control10..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. Annotation.text
    Definition

    The text of the annotation in markdown format.

    ShortThe annotation - text content (as markdown)
    Control1..1
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

    0. Annotation
    2. Annotation.author[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on Annotation.author[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 4. Annotation.author[x]:authorReference
      Slice NameauthorReference
      Control0..1
      TypeReference(SGHI Reference)(Practitioner, PractitionerRole)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      6. Annotation.time
      Control1..?

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

      0. Annotation
      Definition

      A text note which also contains information about who made the statement and when.

      ShortText node with attribution
      Comments

      For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

      Control0..*
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      2. Annotation.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typeid
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Annotation.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Annotation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Annotation.author[x]
        Definition

        The individual responsible for making the annotation.

        ShortIndividual responsible for the annotation
        Comments

        Organization is used when there's no need for specific attribution as to who made the comment.

        Control0..1
        TypeChoice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Annotation.author[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 8. Annotation.author[x]:authorReference
          Slice NameauthorReference
          Definition

          The individual responsible for making the annotation.

          ShortIndividual responsible for the annotation
          Comments

          Organization is used when there's no need for specific attribution as to who made the comment.

          Control0..1
          TypeReference(SGHI Reference)(Practitioner, PractitionerRole)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. Annotation.time
          Definition

          Indicates when this particular annotation was made.

          ShortWhen the annotation was made
          Control1..1
          TypedateTime
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. Annotation.text
          Definition

          The text of the annotation in markdown format.

          ShortThe annotation - text content (as markdown)
          Control1..1
          Typemarkdown
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))