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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
SGHI Activity Defintion Profile |
This resouce allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. |
SGHI AllergyIntolerance |
Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance. |
SGHI Appointment Profile |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
SGHI Care Plan |
A profile on the R5 CarePlan resource to represent a patient's treatment or management plan, such as a chemotherapy regimen. |
SGHI Composition |
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). |
SGHI Condition |
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. |
SGHI Consent |
A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. |
SGHI DiagnosticReport |
SGHI's profile for DiagnosticReport |
SGHI DocumentReference Profile. |
A reference to a document of any kind for any purpose. |
SGHI Encounter |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities. |
SGHI EpisodeOfCare |
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time. |
SGHI Location |
SGHI profile for location |
SGHI Medication |
SGHI's Medication profile for Medication resource |
SGHI Medication Dispense |
SGHI's profile for Medication Dispense resource |
SGHI MedicationRequest |
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called 'MedicationRequest' rather than 'MedicationPrescription' or 'MedicationOrder' to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. |
SGHI Observation |
Measurements and simple assertions made about a patient, device or other subject. |
SGHI Organization |
SGHI's profile for Organization |
SGHI Patient |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
SGHI Plan Definition Profile |
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. |
SGHI Practitioner |
SGHI's Practitioner used in SGHI systems |
SGHI PractitionerRole |
PractitionerRole describes the types of services that practitioners provide to SGHI Organization at specific location(s). The profile a specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. |
SGHI Procedure |
This resource is used to record the details of current and historical procedures performed on, with, or for a patient, practitioner, device, organization, or location. Examples include surgical procedures, diagnostic procedures, endoscopic procedures, biopsies, counseling, physiotherapy, personal support services, adult day care services, non-emergency transportation, home modification, exercise, verification of enrollment qualifications for a social program etc. Procedures may be performed by a healthcare professional, a service provider, a friend or relative or in some cases by the patient themselves. |
SGHI RiskAssessment |
An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome. |
SGHI ServiceRequest |
ServiceRequest represents an order or proposal or plan, as distinguished by ServiceRequest.intent to perform a diagnostic or other service on or for a patient. ServiceRequest represents a proposal or plan or order for a service to be performed that would result in a Procedure or DiagnosticReport, which in turn may reference one or more Observations, which summarize the performance of the procedures and associated documentation such as observations, images, findings that are relevant to the treatment/management of the subject. This resource may be used to share relevant information required to support a referral or a transfer of care request from one practitioner or organization to another when a patient is required to be referred to another provider for a consultation /second opinion and/or for short term or longer term management of one or more health issues or problems. |
SGHI Specimen |
A sample to be used for analysis. |
SGHI Substance |
Profile for representing substances in the SGHI context |
SGHI Task |
SGHI's profile for Task |
These define constraints on FHIR data types for systems conforming to this implementation guide.
SGHI Annotation |
A text note which also contains information about who made the statement and when. |
SGHI Attachment |
A custom document used for capturing the source of consent |
SGHI CodeableConcept |
A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies but may also be defined by the provision of text. This is a common pattern in healthcare data. |
SGHI CodeableReference |
A reusable CodeableReference within SGHI systems |
SGHI ContactPoint |
A custom contact point with stricter cardinality |
SGHI Dosage |
A comprehensive Dosage profile for SGHI prescriptions, ensuring structured routes, methods, timing, and dose details. |
SGHI HumanName |
A specialized human name data type with stricter cardinalities. |
SGHI Reference |
SGHI Reference |
These define sets of codes used by systems conforming to this implementation guide.
All ICD-11 codes |
All codes from ICD-11 |
All ICHI codes |
All codes from ICHI |
All LOINC Codes |
A ValueSet that includes all codes from the LOINC code system. |
Behaviour Value Sets |
Behaviour Value Sets |
Blood Pressure Units |
Units used for measuring blood pressure. |
Cancer Stages Value Sets |
Cancer Stages Value Sets |
Distance Metastatis Value Sets |
Distance Metastatis Value Sets |
Dose Form |
Version 1 |
Encounter Class Value Sets | |
Grade Value Sets |
Grade Value Sets |
Hormone Receptor Status |
Hormone Receptor Status |
Investigations |
First Version |
Laterality Value Sets |
Laterality Value Sets |
Molecular Markers Value Sets |
Molecular Markers Value Sets |
Route Of Administration |
Version 1 |
Route Of Administration |
A ValueSet defining the possible routes of drug administration. |
SGHI Bed Status |
Codes that can be used to indicate the operating status of an organization's location |
SGHI Body Site Value Set |
Custom body site value set |
SGHI Contact Point Use |
Code used to indicate contact use |
SGHI Contact Relationship Types |
Contact relationship types used in SGHI systems |
SGHI Contact System |
Code used to indicate what communications system is required to make use of the contact. |
SGHI Default Code Value Sets |
SGHI Default Code Value Sets |
SGHI Diagnostic Conclusion ICD-11 |
ICD-11 codes used for diagnostic conclusions in SGHI |
SGHI Drugs Identifier Types |
Identifier types used across dm+d hierarchy |
SGHI Encounter Priority |
Urgency of an encounter |
SGHI Investigation Codes |
ValueSet containing SGHI investigation codes |
SGHI Location Form |
Physical form of the location, e.g. building, room, vehicle, road, virtual. |
SGHI Location Mode |
Codes that can be used to indicate the mode of a location |
SGHI Medication Codes |
ValueSet containing SGHI medication codes |
SGHI Medication Form Codes |
ValueSet containing SGHI medication form codes |
SGHI Method Of Medication Administration |
Custom methods of administering medication |
SGHI Organization Identifier Types |
Identifier types used to identify patient in SGHI's systems |
SGHI Patient Identifier Types |
Identifier types used to identify patient in SGHI's systems |
SGHI Practitioner Value Set |
Custom practioner role value set |
SGHI Practitioner Value Set |
Custom practioner specialty value set |
SGHI Procedure Category value set |
A value set for categorizing procedures, using LOINC codes where applicable. |
SGHI Procedure follow up codes |
Custom follow up procedure codes |
SGHI Procedure outcome value set |
The outcome of the procedure - did it resolve the reasons for the procedure being performed? |
SGHI Procedure status value set |
A value set for the status of a procedure, based on the FHIR ProcedureStatus codes. |
SGHI Standard Identifier Types |
Standard identifier types used in SGHI's systems |
SGHI Substance Codes |
ValueSet containing SGHI substance codes |
Service Request Categories |
A ValueSet categorizing different types of service requests. |
Specimen Type Value Sets |
Specimen Type Value Sets |
Type Of Test Value Sets |
Type Of Test Value Sets |
sghi-condition-severity |
Condition severity |
sghi-speciality |
Speciality |
These define new code systems used by systems conforming to this implementation guide.
International Classification for Diseases version 10, WHO |
Based on ICD102019-covid |
International Classification for Diseases version 11, WHO |
This version contains the latest version of ICD-11 (2024) |
KNC4Drugs |
First Version |
KNC4Investigations |
First Version |
Legacy Identifier Types (Deprecated) |
Obsolete identifier-type codes encountered in R4 data. |
Retired CIEL Codes |
A collection of CIEL codes formerly in use for clinical observations. |
Retired FHIR R4 Codes |
A collection of FHIR R 4 codes formerly in used in R4 |
SGHI Identifier Code System |
A single code system enumerating the many local identifier types used across SGHI's environment. |
SGHI LOINC Code System |
A a subset of LOINC codes used across SGHI's environment. |
SGHI Service Request CodeSystem |
A custom CodeSystem defining different elements of service requests. |
SGHI Specialty Code System |
A Specialty Code System to be used in SGHI's environment. |
These define transformations to convert between data structures used by systems conforming to this implementation guide.
Appointment Transforms: R4 → SGHI R5 |
AppointmentTransformsR4SGHIR5 |
Composition Transforms: R4 to SGHI R5 |
CompositionTransformsR4toSGHIR5 |
Condition Transforms: R4 → SGHI R5 |
ConditionTransformsR4SGHIR5 |
Consent Transforms: R4 → SGHI R5 |
ConsentTransformsR4SGHIR5 |
DiagnosticReport Transforms: R4 → SGHI R5 |
DiagnosticReportTransformsR4SGHIR5 |
DocumentReference Transforms: R4 to SGHI R5 |
DocumentReferenceTransformsR4toSGHIR5 |
Encounter Transforms: R4 → SGHI R5 |
EncounterTransformsR4SGHIR5 |
Encounter Transforms: R4 → SGHI R5 |
EncounterTransformsR4SGHIR5 |
EpisodeOfCare Transforms: R4 → SGHI R5 |
EpisodeOfCareTransformsR4SGHIR5 |
Glasgow Coma Scale Extraction |
Extracts three Observation resources, one per GCS subscore, from a QuestionnaireResponse to the GCS questionnaire. |
MedicationRequest Transforms: R4 → SGHI R5 |
MedicationRequestTransformsR4SGHIR5 |
Observation Transforms: R4 to SGHI R5 |
ObservationTransformsR4toSGHIR5 |
Organization Transforms: R4 → SGHI R5 |
OrganizationTransformsR4SGHIR5 |
Patient Transforms: R4 → SGHI R5 |
PatientTransformsR4SGHIR5 |
RiskAssessment Transforms: R4 → SGHI R5 |
RiskAssessmentTransformsR4SGHIR5 |
ServiceRequest Transforms: R4 → SGHI R5 |
ServiceRequestTransformsR4SGHIR5 |
Task Transforms: R4 → SGHI R5 |
TaskTransformsR4SGHIR5 |
These define transformations to convert between codes by systems conforming with this implementation guide.
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
Example ActivityDefinition Title |
An example of SGHIActivityDefinition resource |
Example CarePlan |
SGHI CarePlan demonstration. |
Example SGHI Consent |
An example of consent conforming to the SGHIConsent profile. |
Example SGHI Episode of Care |
An example of an episode of care conforming to the SGHIEpisodeOfCare profile. |
Example SGHI Organization |
An example Organization resource conforming to the SGHIOrganization profile. |
ExampleSGHIAllergyIntolerance |
An example of an AllergyIntolerance resource conforming to the SGHI AllergyIntolerance profile. |
ExampleSGHIAppointment |
An example of an Appointment resource conforming to the SGHI Appointment profile. |
ExampleSGHICondition |
An example of a Condition resource conforming to the SGHI Condition profile. |
ExampleSGHIDiagnosticReport |
An example of an DiagnosticReport resource conforming to the SGHI DiagnostiReport profile. |
ExampleSGHIDocumentReference |
An example of an DocumentReference resource conforming to the SGHI SGHIDocumentReference profile. |
ExampleSGHIEncounter |
An example of an Encounter resource conforming to the SGHI Encounter profile. |
ExampleSGHILocation |
An example of an Location resource conforming to the SGHI Location profile. |
ExampleSGHIMedicationRequest |
An example of a MedicationRequest resource conforming to the SGHI MedicationRequest profile. |
ExampleSGHIObservation |
An example of an Observation resource conforming to the SGHI Observation profile |
ExampleSGHIPatient |
An example of a patient profile. |
ExampleSGHIPractitioner |
An example of a Practitioner resource conforming to the SGHI Practitioner profile |
ExampleSGHIPractitionerRole |
An example of a PractitionerRole resource conforming to the SGHI PractitionerRole profile. |
ExampleSGHIProcedure |
An example of a Procedure resource conforming to the SGHI Procedure profile. |
ExampleSGHIRiskAssessment |
An example of a RiskAssessment resource conforming to the SGHI RiskAssessment profile. |
ExampleSGHIServiceRequest |
An example of a ServiceRequest resource conforming to the SGHI ServiceRequest profile. |
ExampleSGHISpecimen |
An example of Specimen resource that conforms to SGHI Specimen profile |
ExampleSGHISubstance |
An example of a substance profile |
ExampleSGHITask |
An example of a Task resource conforming to the SGHI Task profile. |
PlanDefinition Title |
An example of an PlanDefintion resource conforming to the SGHI PlanDefinition profile. |
SGHI Discharge Summary for John Doe |
An expanded Composition demonstration. |
SGHI Medication Dispense |
An example of a Medication Dispense resource adhering to SGHI's Medication Dispense |
SGHI Medication resource example |
An example of SGHI Medication resource Example |