FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: PlanDefinition/HIVB9DT

Packagesmart.who.int.hiv
Resource TypePlanDefinition
IdHIVB9DT
FHIR VersionR4
Sourcehttp://smart.who.int/hiv/https://build.fhir.org/ig/WorldHealthOrganization/smart-hiv/PlanDefinition-HIVB9DT.html
URLhttp://smart.who.int/hiv/PlanDefinition/HIVB9DT
Version0.4.4
Statusdraft
Date2025-07-24T19:24:35+00:00
NameHIVB9DT
TitleHIV.B9.DT Determine retest recommendation
Authoritywho
DescriptionHIV restesting recommendations

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Id: HIVB9DT
Url: HIV.B9.DT Determine retest recommendation
Version: 0.4.4
Title: HIV.B9.DT Determine retest recommendation
Status: draft
Experimental: true
Type:

system: http://terminology.hl7.org/CodeSystem/plan-definition-type

code: eca-rule

Date: 2025-07-24 19:24:35+0000
Publisher: WHO
Description:

HIV restesting recommendations

Related Artifacts:

References

  • Consolidated Guidelines on HIV Testing Services (2019)


Libraries:
HIV.B9.DT Logic
Actions:
Determine retest recommendation
Then:
Schedule an annual follow-up test
If: Applicability: (Schedule an annual follow-up test)
Then: Definition: HIV.B9.DT Schedule Follow-up Test
Dynamic Values:
intent: ('plan' from "http://hl7.org/fhir/request-intent")
code.coding: ('171121004' from "SNOMED-CT" display 'HIV screening')
occurrenceDateTime: (Schedule Date)
Schedule quarterly retesting for PrEP users
If: Applicability: (Schedule quarterly retesting for PrEP users)
Then: Definition: HIV.B9.DT Schedule Follow-up Test
Dynamic Values:
intent: ('plan' from "http://hl7.org/fhir/request-intent")
code.coding: ('171121004' from "SNOMED-CT" display 'HIV screening')
occurrenceDateTime: (Schedule Date)
Follow-up test recommended
If: Applicability: (Follow-up test recommended)
Then: Definition: HIV.B9.DT Schedule Follow-up Test
Dynamic Values:
intent: ('proposal' from "http://hl7.org/fhir/request-intent")
code.coding: ('171121004' from "SNOMED-CT" display 'HIV screening')
Schedule an HIV test, syphilis test, hepatitis B test as early as possible during this pregnancy
If: Applicability: (Schedule an HIV test, syphilis test, hepatitis B test as early as possible during this pregnancy)
Then: Additional sub-actions not displayed
Schedule a follow-up tests for pregnant persons
If: Applicability: (Schedule a 'Follow-up test recommended date' at first ANC contact date)
Then: Additional sub-actions not displayed
Send retest recommendation to provider
If: Applicability: (Guidance)
Then: Definition: HIVGuidanceCommunicationRequestActivity
Dynamic Values:
description: (Guidance)

Source

{
  "resourceType": "PlanDefinition",
  "id": "HIVB9DT",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-recommendationdefinition",
      "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableplandefinition",
      "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableplandefinition"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability",
      "valueCode": "computable"
    }
  ],
  "url": "http://smart.who.int/hiv/PlanDefinition/HIVB9DT",
  "version": "0.4.4",
  "name": "HIVB9DT",
  "title": "HIV.B9.DT Determine retest recommendation",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code": "eca-rule"
      }
    ]
  },
  "status": "draft",
  "experimental": true,
  "date": "2025-07-24T19:24:35+00:00",
  "publisher": "WHO",
  "contact": [
    {
      "name": "WHO",
      "telecom": [
        {
          "system": "url",
          "value": "http://who.int"
        }
      ]
    }
  ],
  "description": "HIV restesting recommendations",
  "relatedArtifact": [
    {
      "type": "citation",
      "citation": "Consolidated Guidelines on HIV Testing Services (2019)"
    }
  ],
  "library": [
    "http://smart.who.int/hiv/Library/HIVB9DTLogic"
  ],
  "action": [
    {
      "textEquivalent": "Determine retest recommendation",
      "action": [
        {
          "textEquivalent": "Schedule an annual follow-up test",
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql-identifier",
                "expression": "Schedule an annual follow-up test"
              }
            }
          ],
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/action-type",
                "code": "create"
              }
            ]
          },
          "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
          "dynamicValue": [
            {
              "path": "intent",
              "expression": {
                "description": "Intent = 'plan'",
                "language": "text/cql",
                "expression": "'plan' from \"http://hl7.org/fhir/request-intent\""
              }
            },
            {
              "path": "code.coding",
              "expression": {
                "description": "HIV Screening",
                "language": "text/cql",
                "expression": "'171121004' from \"SNOMED-CT\" display 'HIV screening'"
              }
            },
            {
              "path": "occurrenceDateTime",
              "expression": {
                "description": "At the recommended interval",
                "language": "text/cql-identifier",
                "expression": "Schedule Date"
              }
            }
          ]
        },
        {
          "textEquivalent": "Schedule quarterly retesting for PrEP users",
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql-identifier",
                "expression": "Schedule quarterly retesting for PrEP users"
              }
            }
          ],
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/action-type",
                "code": "create"
              }
            ]
          },
          "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
          "dynamicValue": [
            {
              "path": "intent",
              "expression": {
                "description": "Intent = 'plan'",
                "language": "text/cql",
                "expression": "'plan' from \"http://hl7.org/fhir/request-intent\""
              }
            },
            {
              "path": "code.coding",
              "expression": {
                "description": "HIV Screening",
                "language": "text/cql",
                "expression": "'171121004' from \"SNOMED-CT\" display 'HIV screening'"
              }
            },
            {
              "path": "occurrenceDateTime",
              "expression": {
                "description": "At the recommended interval",
                "language": "text/cql-identifier",
                "expression": "Schedule Date"
              }
            }
          ]
        },
        {
          "textEquivalent": "Follow-up test recommended",
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql-identifier",
                "expression": "Follow-up test recommended"
              }
            }
          ],
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/action-type",
                "code": "create"
              }
            ]
          },
          "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
          "dynamicValue": [
            {
              "path": "intent",
              "expression": {
                "description": "Intent = 'proposal'",
                "language": "text/cql",
                "expression": "'proposal' from \"http://hl7.org/fhir/request-intent\""
              }
            },
            {
              "path": "code.coding",
              "expression": {
                "description": "HIV Screening",
                "language": "text/cql",
                "expression": "'171121004' from \"SNOMED-CT\" display 'HIV screening'"
              }
            }
          ]
        },
        {
          "textEquivalent": "Schedule an HIV test, syphilis test, hepatitis B test as early as possible during this pregnancy",
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql-identifier",
                "expression": "Schedule an HIV test, syphilis test, hepatitis B test as early as possible during this pregnancy"
              }
            }
          ],
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/action-type",
                "code": "create"
              }
            ]
          },
          "action": [
            {
              "textEquivalent": "Schedule an HIV test as early as possible",
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/action-type",
                    "code": "create"
                  }
                ]
              },
              "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
              "dynamicValue": [
                {
                  "path": "intent",
                  "expression": {
                    "description": "Intent = 'proposal'",
                    "language": "text/cql",
                    "expression": "'proposal' from \"http://hl7.org/fhir/request-intent\""
                  }
                },
                {
                  "path": "code.coding",
                  "expression": {
                    "description": "HIV test",
                    "language": "text/cql",
                    "expression": "'171121004' from \"SNOMED-CT\" display 'HIV test'"
                  }
                }
              ]
            },
            {
              "textEquivalent": "Schedule a Syphilis test as early as possible",
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/action-type",
                    "code": "create"
                  }
                ]
              },
              "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
              "dynamicValue": [
                {
                  "path": "intent",
                  "expression": {
                    "description": "Intent = 'proposal'",
                    "language": "text/cql",
                    "expression": "'proposal' from \"http://hl7.org/fhir/request-intent\""
                  }
                },
                {
                  "path": "code.coding",
                  "expression": {
                    "description": "Syphilis test",
                    "language": "text/cql",
                    "expression": "'40675008' from \"SNOMED-CT\" display 'Syphilis test'"
                  }
                }
              ]
            },
            {
              "textEquivalent": "Schedule a Heptatitis test as early as possible",
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/action-type",
                    "code": "create"
                  }
                ]
              },
              "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
              "dynamicValue": [
                {
                  "path": "intent",
                  "expression": {
                    "description": "Intent = 'proposal'",
                    "language": "text/cql",
                    "expression": "'proposal' from \"http://hl7.org/fhir/request-intent\""
                  }
                },
                {
                  "path": "code.coding",
                  "expression": {
                    "description": "Heptatitis B test",
                    "language": "text/cql",
                    "expression": "'313476009' from \"SNOMED-CT\" display 'Heptatitis B test'"
                  }
                }
              ]
            }
          ]
        },
        {
          "textEquivalent": "Schedule a follow-up tests for pregnant persons",
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql-identifier",
                "expression": "Schedule a 'Follow-up test recommended date' at first ANC contact date"
              }
            }
          ],
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/action-type",
                "code": "create"
              }
            ]
          },
          "action": [
            {
              "textEquivalent": "Schedule a follow-up test recommended date at first ANC contact date",
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/action-type",
                    "code": "create"
                  }
                ]
              },
              "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
              "dynamicValue": [
                {
                  "path": "intent",
                  "expression": {
                    "description": "Intent = 'proposal'",
                    "language": "text/cql",
                    "expression": "'proposal' from \"http://hl7.org/fhir/request-intent\""
                  }
                },
                {
                  "path": "code.coding",
                  "expression": {
                    "description": "HIV Screening",
                    "language": "text/cql",
                    "expression": "'171121004' from \"SNOMED-CT\" display 'HIV screening'"
                  }
                }
              ]
            },
            {
              "textEquivalent": "Schedule a follow-up test recommended date during a third trimester visit",
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/action-type",
                    "code": "create"
                  }
                ]
              },
              "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
              "dynamicValue": [
                {
                  "path": "intent",
                  "expression": {
                    "description": "Intent = 'proposal'",
                    "language": "text/cql",
                    "expression": "'proposal' from \"http://hl7.org/fhir/request-intent\""
                  }
                },
                {
                  "path": "code.coding",
                  "expression": {
                    "description": "HIV Screening",
                    "language": "text/cql",
                    "expression": "'171121004' from \"SNOMED-CT\" display 'HIV screening'"
                  }
                }
              ]
            },
            {
              "textEquivalent": "Schedule a follow-up test recommended date either two-weeks, 6 months or 9 months post delivery",
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/action-type",
                    "code": "create"
                  }
                ]
              },
              "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVB9DTScheduleFollowUp",
              "dynamicValue": [
                {
                  "path": "intent",
                  "expression": {
                    "description": "Intent = 'proposal'",
                    "language": "text/cql",
                    "expression": "'proposal' from \"http://hl7.org/fhir/request-intent\""
                  }
                },
                {
                  "path": "code.coding",
                  "expression": {
                    "description": "HIV Screening",
                    "language": "text/cql",
                    "expression": "'171121004' from \"SNOMED-CT\" display 'HIV screening'"
                  }
                }
              ]
            }
          ]
        },
        {
          "textEquivalent": "Send retest recommendation to provider",
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql-identifier",
                "expression": "Guidance"
              }
            }
          ],
          "definitionCanonical": "http://smart.who.int/hiv/ActivityDefinition/HIVGuidanceCommunicationRequestActivity",
          "dynamicValue": [
            {
              "path": "description",
              "expression": {
                "language": "text/cql-identifier",
                "expression": "Guidance"
              }
            }
          ]
        }
      ]
    }
  ]
}