| Package | smart.who.int.hiv |
| Resource Type | StructureDefinition |
| Id | HIVIReferral |
| FHIR Version | R4 |
| Source | http://smart.who.int/hiv/https://build.fhir.org/ig/WorldHealthOrganization/smart-hiv/StructureDefinition-HIVIReferral.html |
| URL | http://smart.who.int/hiv/StructureDefinition/HIVIReferral |
| Version | 0.4.4 |
| Status | active |
| Date | 2025-07-24T19:24:35+00:00 |
| Name | HIVIReferral |
| Title | HIV.I Referral |
| Authority | who |
| Description | This tab describes the data that are collected during the referral workflow (HIV.I) |
| Type | http://smart.who.int/hiv/StructureDefinition/HIVIReferral |
| Kind | logical |
No resources found
| ValueSet | |
| HIV.I.DE2 | Reason for referral ValueSet |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition HIVIReferral
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HIVIReferral | 0..* | Base | HIV.I Referral Instances of this logical model can be the target of a Reference | |
  emergencyReferral | 1..1 | boolean | Emergency referral | |
 reasonForReferral | 1..* | Coding | Reason for referral Binding: Reason for referral ValueSet (required) | |
| referralForOtherGeneralServicesSpecify | 0..1 | string | Referral for other general services (specify) | |
| anyTreatmentGivenBeforeReferral | 1..1 | boolean | Any treatment given before referral? | |
| dateOfScheduledReferralAppointment | 1..1 | dateTime | Date of scheduled referral appointment | |
| locationOfScheduledReferralAppointment | 1..1 | string | Location of scheduled referral appointment | |
| dateReferralWasMade | 1..1 | dateTime | Date referral was made | |
| providerWhoMadeReferral | 1..1 | string | Provider who made referral | |
| providerFacility | 1..1 | string | Provider's facility | |
| providerTelephoneNumber | 1..1 | integer | Provider's telephone number | |
| referralNotes | 1..1 | string | Referral notes | |
 clientHistorySummary | 1..1 | string | Client history summary | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "HIVIReferral",
"meta": {
"profile": [
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablestructuredefinition",
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition"
]
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"valueBoolean": true
}
],
"url": "http://smart.who.int/hiv/StructureDefinition/HIVIReferral",
"version": "0.4.4",
"name": "HIVIReferral",
"title": "HIV.I Referral",
"status": "active",
"experimental": true,
"date": "2025-07-24T19:24:35+00:00",
"publisher": "WHO",
"contact": [
{
"name": "WHO",
"telecom": [
{
"system": "url",
"value": "http://who.int"
}
]
}
],
"description": "This tab describes the data that are collected during the referral workflow (HIV.I)",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://smart.who.int/hiv/StructureDefinition/HIVIReferral",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "HIVIReferral",
"path": "HIVIReferral",
"short": "HIV.I Referral",
"definition": "This tab describes the data that are collected during the referral workflow (HIV.I)",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "HIVIReferral.emergencyReferral",
"path": "HIVIReferral.emergencyReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE1"
}
],
"short": "Emergency referral",
"definition": "Referral for urgent care",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.emergencyReferral",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "HIVIReferral.reasonForReferral",
"path": "HIVIReferral.reasonForReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE2"
}
],
"short": "Reason for referral",
"definition": "Reason why the client is being referred. If diagnosed, this may include the reason for the diagnosis.",
"min": 1,
"max": "*",
"base": {
"path": "HIVIReferral.reasonForReferral",
"min": 1,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"valueSet": "http://smart.who.int/hiv/ValueSet/HIV.I.DE2"
}
},
{
"id": "HIVIReferral.referralForOtherGeneralServicesSpecify",
"path": "HIVIReferral.referralForOtherGeneralServicesSpecify",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE8"
}
],
"short": "Referral for other general services (specify)",
"definition": "If none of the reasons above apply, specify the reason(s)",
"min": 0,
"max": "1",
"base": {
"path": "HIVIReferral.referralForOtherGeneralServicesSpecify",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.anyTreatmentGivenBeforeReferral",
"path": "HIVIReferral.anyTreatmentGivenBeforeReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE9"
}
],
"short": "Any treatment given before referral?",
"definition": "If client was referred, was any treatment provided before referral?",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.anyTreatmentGivenBeforeReferral",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "HIVIReferral.dateOfScheduledReferralAppointment",
"path": "HIVIReferral.dateOfScheduledReferralAppointment",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE10"
}
],
"short": "Date of scheduled referral appointment",
"definition": "When the referral is scheduled",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.dateOfScheduledReferralAppointment",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HIVIReferral.locationOfScheduledReferralAppointment",
"path": "HIVIReferral.locationOfScheduledReferralAppointment",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE11"
}
],
"short": "Location of scheduled referral appointment",
"definition": "Where the client is being referred to",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.locationOfScheduledReferralAppointment",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.dateReferralWasMade",
"path": "HIVIReferral.dateReferralWasMade",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE12"
}
],
"short": "Date referral was made",
"definition": "The date the referral was made",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.dateReferralWasMade",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HIVIReferral.providerWhoMadeReferral",
"path": "HIVIReferral.providerWhoMadeReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE13"
}
],
"short": "Provider who made referral",
"definition": "The name of the provider who made the referral",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.providerWhoMadeReferral",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.providerFacility",
"path": "HIVIReferral.providerFacility",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE14"
}
],
"short": "Provider's facility",
"definition": "Facility client is being referred from",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.providerFacility",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.providerTelephoneNumber",
"path": "HIVIReferral.providerTelephoneNumber",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE15"
}
],
"short": "Provider's telephone number",
"definition": "The contact details of the provider making the referral",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.providerTelephoneNumber",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "HIVIReferral.referralNotes",
"path": "HIVIReferral.referralNotes",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE16"
}
],
"short": "Referral notes",
"definition": "Any additional relevant details of clinical significance for the referral facility to provide quality care",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.referralNotes",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.clientHistorySummary",
"path": "HIVIReferral.clientHistorySummary",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE17"
}
],
"short": "Client history summary",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "HIVIReferral.clientHistorySummary",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "HIVIReferral",
"path": "HIVIReferral",
"short": "HIV.I Referral",
"definition": "This tab describes the data that are collected during the referral workflow (HIV.I)"
},
{
"id": "HIVIReferral.emergencyReferral",
"path": "HIVIReferral.emergencyReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE1"
}
],
"short": "Emergency referral",
"definition": "Referral for urgent care",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "HIVIReferral.reasonForReferral",
"path": "HIVIReferral.reasonForReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE2"
}
],
"short": "Reason for referral",
"definition": "Reason why the client is being referred. If diagnosed, this may include the reason for the diagnosis.",
"min": 1,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"valueSet": "http://smart.who.int/hiv/ValueSet/HIV.I.DE2"
}
},
{
"id": "HIVIReferral.referralForOtherGeneralServicesSpecify",
"path": "HIVIReferral.referralForOtherGeneralServicesSpecify",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE8"
}
],
"short": "Referral for other general services (specify)",
"definition": "If none of the reasons above apply, specify the reason(s)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.anyTreatmentGivenBeforeReferral",
"path": "HIVIReferral.anyTreatmentGivenBeforeReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE9"
}
],
"short": "Any treatment given before referral?",
"definition": "If client was referred, was any treatment provided before referral?",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "HIVIReferral.dateOfScheduledReferralAppointment",
"path": "HIVIReferral.dateOfScheduledReferralAppointment",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE10"
}
],
"short": "Date of scheduled referral appointment",
"definition": "When the referral is scheduled",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HIVIReferral.locationOfScheduledReferralAppointment",
"path": "HIVIReferral.locationOfScheduledReferralAppointment",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE11"
}
],
"short": "Location of scheduled referral appointment",
"definition": "Where the client is being referred to",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.dateReferralWasMade",
"path": "HIVIReferral.dateReferralWasMade",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE12"
}
],
"short": "Date referral was made",
"definition": "The date the referral was made",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HIVIReferral.providerWhoMadeReferral",
"path": "HIVIReferral.providerWhoMadeReferral",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE13"
}
],
"short": "Provider who made referral",
"definition": "The name of the provider who made the referral",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.providerFacility",
"path": "HIVIReferral.providerFacility",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE14"
}
],
"short": "Provider's facility",
"definition": "Facility client is being referred from",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.providerTelephoneNumber",
"path": "HIVIReferral.providerTelephoneNumber",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE15"
}
],
"short": "Provider's telephone number",
"definition": "The contact details of the provider making the referral",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "HIVIReferral.referralNotes",
"path": "HIVIReferral.referralNotes",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE16"
}
],
"short": "Referral notes",
"definition": "Any additional relevant details of clinical significance for the referral facility to provide quality care",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HIVIReferral.clientHistorySummary",
"path": "HIVIReferral.clientHistorySummary",
"code": [
{
"system": "http://smart.who.int/hiv/CodeSystem/HIVConcepts",
"code": "HIV.I.DE17"
}
],
"short": "Client history summary",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}