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: SGHI Reference

Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-reference Version: 0.1.0
Draft as of 2025-09-04 Computable Name: SGHIReference

SGHI Reference

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1, ref-2
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... display ΣC 1..1 string Text alternative for the resource

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference Reference
... reference 1..1 string Literal reference, Relative, internal or absolute URL
... display 1..1 string Text alternative for the resource

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1, ref-2
... id 0..1 id Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
... display ΣC 1..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

This structure is derived from Reference

Summary

Mandatory: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1, ref-2
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... display ΣC 1..1 string Text alternative for the resource

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

Differential View

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference Reference
... reference 1..1 string Literal reference, Relative, internal or absolute URL
... display 1..1 string Text alternative for the resource

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1, ref-2
... id 0..1 id Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
... display ΣC 1..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

This structure is derived from Reference

Summary

Mandatory: 2 elements

 

Other representations of profile: CSV, Excel, Schematron