Starter FHIR Implementation Guide
1.0.1 - ci-build International flag

Starter FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Starter-FHIR-IG/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Knowledge Artifacts: Libraries

These define logic, asset collections and other libraries as part of content in this implementation guide.

CQL - FHIRCommon

Base FHIRCommon Include.

CQL - FHIRHelpers

Base FHIRHelpers Include.

CQL - HIV Common

Common CQL for HIV calculations.

CQL - HIV+ Patients Initiated on ART

CQL Measure that reports on all HIV+ patients who have been initiated on ART within the reporting period.

CQL - Local Common

Common functions for all CQL calculations.

CQL - Most Recent Viral Load Status

Checks for the most recent viral load and determines the suppression status.

CQL - Viral Load (All Patients)

CQL Measure that reports on all patients who have a HIV viral load date within the reporting period.

CQL - Viral Load (Outpatients only)

CQL Measure that reports on all outpatients who have a HIV viral load date within the reporting period.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

Patient Logical Model

Exchange requirements example for the Patient Resource.

Related Person Logical Model

Exchange requirements example for the RelatedPerson Resource.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Encounter - Initiated By The Facility Providing the Service

Represents the current facility at which the patient is receiving health services.

Medication - Represents an ARV Regimen

Used to record the ARV regimen that will be prescribed to the patient.

Medication Administration - For Prescribed ARV Medication

Used to record the medication administration period for prescribed ARV medication.

Medication Dispense - Generic

Base Medication Request elements that are inherited by other Medication Request profiles.

Medication Request - ARV

Used to record requests for ARV medication that are prescribed to a patient.

Observation - ART Follow-up Status

Represents the patient's current ART follow-up status.

Observation - Confirmed HIV positive

Represents the date the patient was confirmed HIV positive.

Observation - Generic

Base Observation elements that are inherited by other Observation profiles.

Observation - Viral Load Result

Represents the patient's Viral Load Result.

Organization

Organization providing health related services.

Patient

A profile representing the Patient exchange requirements in the Logical Model "Patient Logical Model". Refer to the Mappings tab to see the data element associations between this profile and the Logical Model.

Practitioner - General Practitioner

Represents the practitioner who participated in the observation.

Related Person

A profile representing the RelatedPerson exchange requirements in the Logical Model "Related Person Logical Model". Refer to the Mappings tab to see the data element associations between this profile and the Logical Model.

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

Strict Coding

Strict requirements for elements using the Coding data types.

Strict Quantity

Strict requirements for quantity-based measurements.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Date and Time Associated with the Assertion

Represents the date and time to be documented together with the assertion. This is not necessarily the same date and time the Observation was created! For example, it can be used to record a date and time in the past to indicate when a patient reached a certin clinical status.

Patient Marital Status

An extension to capture the marital status.

Patient Marital Status Date

An extension to capture the date for when the marital status came into effect.

Patient Marital Status and Effective Date

An extension to capture the marital status and the effective date for when the marital status came into effect.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ARV Drugs

A list of codes describing the ARV Drugs.

Follow Up Status

FollowUp Status

HIV Test Results

HIV Test Results

HIV Test Types

HIV Test Types

Marital Status

A list of codes for marital status.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Marital Status

A list of codes for marital status.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Encounter - Referencing a General Patient

Represents the current facility at which the patient is receiving health services.

Logical Model: Patient - Example 1 (Marital Status Captured)

Patient documented as married.

Logical Model: Patient - Example 2 (Marital Status Not Captured)

Patient marital status not documented.

Logical Model: Patient - Example 3 (Marital Status Not Captured)

Patient marital status not documented but includes a Mother relationship.

Note: Includes patient relation.
Logical Model: Related Person - Mother Relationship (Example 1)

Marital status documented using a HL7 code.

Logical Model: Related Person - Mother Relationship (Example 2)

Marital status documented using a proprietary code.

Medication - Represents an ARV Regimen

Used to record the ARV regimen that will be prescribed to the patient.

Medication Administration - For Prescribed ARV Medication

Used to record the medication administration period for prescribed ARV medication.

Medication Request - ARV Prescribed to a Patient Who Initiated ART

This is to record requests for medication that are prescribed to a patient (Initiated on ART).

Observation - Confirmed HIV positive After PCR Testing

Represents the patient's PCR HIV test result.

Observation - Initiated On ART

Indicates that the patient is initiated on ART.

Observation - Suppressed Viral Load Result

Represents the patient's viral load result as suppressed.

Observation - Unsuppressed Viral Load Result

Represents the patient's viral load result as unsuppressed followed by enhanced adherence counselling.

Organization - Current Facility

Current organization providing health related services.

Patient - Example 1 (Marital Status Captured)

Patient documented as married.

Patient - Example 2 (Marital Status Not Captured)

Patient marital status not documented.

Patient - Example 3 (Marital Status Not Captured)

Patient marital status not documented but includes a Mother relationship.

Note: Includes patient relation.
Practitioner - General Practitioner

Represents the practitioners who participated in the observation.

Related Person - Mother Relationship (Example 1)

Marital status documented using a HL7 code.

Related Person - Mother Relationship (Example 2)

Marital status documented using a proprietary code.