WHO SMART Guidelines - HIV
0.3.0 - ci-build

WHO SMART Guidelines - HIV - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: HIVIReferral - Detailed Descriptions

Active as of 2024-12-06

Definitions for the HIVIReferral logical model.

Guidance on how to interpret the contents of this table can be found here

0. HIVIReferral
Definition

This tab describes the data that are collected during the referral workflow (HIV.I)

ShortHIV.I Referral
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVIReferral.emergencyReferral
Definition

Referral for urgent care

ShortEmergency referral
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE1
4. HIVIReferral.reasonForReferral
Definition

Reason why the client is being referred. If diagnosed, this may include the reason for the diagnosis.

ShortReason for referral
Control1..*
BindingThe codes SHALL be taken from Reason for referral ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.I.DE2)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE2
6. HIVIReferral.referralForOtherGeneralServicesSpecify
Definition

If none of the reasons above apply, specify the reason(s)

ShortReferral for other general services (specify)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE8
8. HIVIReferral.anyTreatmentGivenBeforeReferral
Definition

If client was referred, was any treatment provided before referral?

ShortAny treatment given before referral?
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE9
10. HIVIReferral.dateOfScheduledReferralAppointment
Definition

When the referral is scheduled

ShortDate of scheduled referral appointment
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE10
12. HIVIReferral.locationOfScheduledReferralAppointment
Definition

Where the client is being referred to

ShortLocation of scheduled referral appointment
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE11
14. HIVIReferral.dateReferralWasMade
Definition

The date the referral was made

ShortDate referral was made
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE12
16. HIVIReferral.providerWhoMadeReferral
Definition

The name of the provider who made the referral

ShortProvider who made referral
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE13
18. HIVIReferral.providerFacility
Definition

Facility client is being referred from

ShortProvider's facility
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE14
20. HIVIReferral.providerTelephoneNumber
Definition

The contact details of the provider making the referral

ShortProvider's telephone number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE15
22. HIVIReferral.referralNotes
Definition

Any additional relevant details of clinical significance for the referral facility to provide quality care

ShortReferral notes
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE16
24. HIVIReferral.clientHistorySummary
Definition

With interoperable systems, the provider receiving the referral should be able to access the client's health record digitally. However, in the absence of this, the referral provider should receive a summary of the client's health records that includes the client's history, medications, medications prescribed or dispensed, reported issues and concerns, and any other relevant clinical information the health care provider had already obtained.

ShortClient history summary
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE17

Guidance on how to interpret the contents of this table can be found here

0. HIVIReferral
Definition

This tab describes the data that are collected during the referral workflow (HIV.I)

ShortHIV.I Referral
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVIReferral.emergencyReferral
Definition

Referral for urgent care

ShortEmergency referral
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE1
4. HIVIReferral.reasonForReferral
Definition

Reason why the client is being referred. If diagnosed, this may include the reason for the diagnosis.

ShortReason for referral
Control1..*
BindingThe codes SHALL be taken from Reason for referral ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.I.DE2)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE2
6. HIVIReferral.referralForOtherGeneralServicesSpecify
Definition

If none of the reasons above apply, specify the reason(s)

ShortReferral for other general services (specify)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE8
8. HIVIReferral.anyTreatmentGivenBeforeReferral
Definition

If client was referred, was any treatment provided before referral?

ShortAny treatment given before referral?
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE9
10. HIVIReferral.dateOfScheduledReferralAppointment
Definition

When the referral is scheduled

ShortDate of scheduled referral appointment
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE10
12. HIVIReferral.locationOfScheduledReferralAppointment
Definition

Where the client is being referred to

ShortLocation of scheduled referral appointment
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE11
14. HIVIReferral.dateReferralWasMade
Definition

The date the referral was made

ShortDate referral was made
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE12
16. HIVIReferral.providerWhoMadeReferral
Definition

The name of the provider who made the referral

ShortProvider who made referral
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE13
18. HIVIReferral.providerFacility
Definition

Facility client is being referred from

ShortProvider's facility
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE14
20. HIVIReferral.providerTelephoneNumber
Definition

The contact details of the provider making the referral

ShortProvider's telephone number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE15
22. HIVIReferral.referralNotes
Definition

Any additional relevant details of clinical significance for the referral facility to provide quality care

ShortReferral notes
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE16
24. HIVIReferral.clientHistorySummary
Definition

With interoperable systems, the provider receiving the referral should be able to access the client's health record digitally. However, in the absence of this, the referral provider should receive a summary of the client's health records that includes the client's history, medications, medications prescribed or dispensed, reported issues and concerns, and any other relevant clinical information the health care provider had already obtained.

ShortClient history summary
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE17

Guidance on how to interpret the contents of this table can be found here

0. HIVIReferral
Definition

This tab describes the data that are collected during the referral workflow (HIV.I)

ShortHIV.I Referral
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVIReferral.emergencyReferral
Definition

Referral for urgent care

ShortEmergency referral
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE1
4. HIVIReferral.reasonForReferral
Definition

Reason why the client is being referred. If diagnosed, this may include the reason for the diagnosis.

ShortReason for referral
Control1..*
BindingThe codes SHALL be taken from Reason for referral ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.I.DE2)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE2
6. HIVIReferral.referralForOtherGeneralServicesSpecify
Definition

If none of the reasons above apply, specify the reason(s)

ShortReferral for other general services (specify)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE8
8. HIVIReferral.anyTreatmentGivenBeforeReferral
Definition

If client was referred, was any treatment provided before referral?

ShortAny treatment given before referral?
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE9
10. HIVIReferral.dateOfScheduledReferralAppointment
Definition

When the referral is scheduled

ShortDate of scheduled referral appointment
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE10
12. HIVIReferral.locationOfScheduledReferralAppointment
Definition

Where the client is being referred to

ShortLocation of scheduled referral appointment
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE11
14. HIVIReferral.dateReferralWasMade
Definition

The date the referral was made

ShortDate referral was made
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE12
16. HIVIReferral.providerWhoMadeReferral
Definition

The name of the provider who made the referral

ShortProvider who made referral
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE13
18. HIVIReferral.providerFacility
Definition

Facility client is being referred from

ShortProvider's facility
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE14
20. HIVIReferral.providerTelephoneNumber
Definition

The contact details of the provider making the referral

ShortProvider's telephone number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE15
22. HIVIReferral.referralNotes
Definition

Any additional relevant details of clinical significance for the referral facility to provide quality care

ShortReferral notes
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE16
24. HIVIReferral.clientHistorySummary
Definition

With interoperable systems, the provider receiving the referral should be able to access the client's health record digitally. However, in the absence of this, the referral provider should receive a summary of the client's health records that includes the client's history, medications, medications prescribed or dispensed, reported issues and concerns, and any other relevant clinical information the health care provider had already obtained.

ShortClient history summary
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.I.DE17