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 2026-05-21

Definitions for the codeable-reference data type profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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).
Short | Reference to a resource or a concept
Control | 0..*
Is Modifier | false
Invariants | ele-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.
Short | Reference to a concept (by class)
Control | 0..1
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Reference to a resource (by instance)
Control | 0..1
Type | Reference(SGHI Reference)
Is Modifier | false
Summary | true
Invariants | ele-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
Type | CodeableConcept(SGHI CodeableConcept)
4. CodeableReference.reference
Type | Reference(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).
Short | Reference to a resource or a concept
Control | 0..*
Is Modifier | false
Invariants | ele-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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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.
Short | Reference to a concept (by class)
Control | 0..1
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Reference to a resource (by instance)
Control | 0..1
Type | Reference(SGHI Reference)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)