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: SGHICodeableReference - Detailed Descriptions

Draft as of 2025-09-04

Definitions for the sghi-codeable-reference data type profile.

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

0. CodeableReference
Definition

A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).

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

A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.

ShortReference to a concept (by class)
Control0..1
TypeCodeableConcept(SGHI CodeableConcept)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CodeableReference.reference
Definition

A reference to a resource the provides exact details about the information being referenced.

ShortReference to a resource (by instance)
Control0..1
TypeReference(SGHI Reference)
Is Modifierfalse
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. CodeableReference
2. CodeableReference.concept
TypeCodeableConcept(SGHI CodeableConcept)
4. CodeableReference.reference
TypeReference(SGHI Reference)

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

0. CodeableReference
Definition

A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).

ShortReference to a resource or a concept
Control0..*
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. CodeableReference.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. CodeableReference.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 CodeableReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. CodeableReference.concept
    Definition

    A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.

    ShortReference to a concept (by class)
    Control0..1
    TypeCodeableConcept(SGHI CodeableConcept)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. CodeableReference.reference
    Definition

    A reference to a resource the provides exact details about the information being referenced.

    ShortReference to a resource (by instance)
    Control0..1
    TypeReference(SGHI Reference)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))