SIL HIE 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/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
Data Type Profile: HIE Reference
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/hie-reference | Version: 0.1.0 | |||
| Active as of 2025-11-25 | Computable Name: HIEReference | |||
A Reference that is resolvable, with display for UX.
Usages:
- Use this DataType Profile: HIE AllergyIntolerance, HIE Appointment, HIE AppointmentResponse, HIE Claim... Show 19 more
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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Reference |
C | 0..* | Reference | A reference from one resource to another Constraints: ref-1 |
  reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
 display |
SΣ | 1..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource |
hasValue() or (children().count() > id.count()) or $this is Parameters
|
| ref-1 | error | Reference | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 0..* | Reference | A reference from one resource to another Constraints: ref-1 |
| 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 |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
 identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
SΣ | 1..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource |
hasValue() or (children().count() > id.count()) or $this is Parameters
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ref-1 | error | Reference | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)
|
This structure is derived from Reference
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 0..* | Reference | A reference from one resource to another Constraints: ref-1 |
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| display |
SΣ | 1..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource |
hasValue() or (children().count() > id.count()) or $this is Parameters
|
| ref-1 | error | Reference | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)
|
Differential View
This structure is derived from Reference
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Reference |
C | 0..* | Reference | A reference from one resource to another Constraints: ref-1 |
| 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 |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
SΣ | 1..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Reference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource |
hasValue() or (children().count() > id.count()) or $this is Parameters
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ref-1 | error | Reference | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)
|
This structure is derived from Reference
Other representations of profile: CSV, Excel, Schematron