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

FHIR IG Statistics: PlanDefinition/IMMZD18SHepatitisB3Dose

Packagesmart.who.int.immunizations
Resource TypePlanDefinition
IdIMMZD18SHepatitisB3Dose
FHIR VersionR4
Sourcehttp://smart.who.int/immunizations/https://build.fhir.org/ig/WorldHealthOrganization/smart-immunizations/PlanDefinition-IMMZD18SHepatitisB3Dose.html
URLhttp://smart.who.int/immunizations/PlanDefinition/IMMZD18SHepatitisB3Dose
Version0.2.0
Statusdraft
Date2025-07-25T21:56:21+00:00
NameIMMZD18SHepatitisB3Dose
TitleIMMZ.D18.S.Hepatitis B.3-dose schedule
Authoritywho
DescriptionIMMZ.D18.S.Hepatitis B.3-dose schedule 3-dose schedule (birth dose + 2 primary series doses), on-time start

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: IMMZD18SHepatitisB3Dose
Url: IMMZ.D18.S.Hepatitis B.3-dose schedule
Version: 0.2.0
Title: IMMZ.D18.S.Hepatitis B.3-dose schedule
Status: draft
Type:

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

code: eca-rule

Date: 2025-07-25 21:56:21+0000
Publisher: WHO
Description:

IMMZ.D18.S.Hepatitis B.3-dose schedule 3-dose schedule (birth dose + 2 primary series doses), on-time start

Knowledge Capability: computable
Related Artifacts:

References

  • WHO recommendations for routine immunization - summary tables (January 2025)


Libraries:
IMMZD18SHepatitisB3DoseLogic
Actions:
Hepatitis B dose 1: Provision of hepatitis B dose 1 Trigger event: Child's birth Trigger date: "Date of birth" Create condition: The following option is considered appropriate: a 3-dose schedule with the first dose (monovalent) being given at birth and the second and third (monovalent or as part of a combined vaccine) given at the same time as the first and third doses of DTP-containing vaccine. The interval between doses should be at least 4 weeks.
If: Applicability: Hepatitis B dose 1 (Hepatitis B dose 1)
Then: Definition: IMMZ.D2.DT.CR
Dynamic Values:
status: ('active')
payload.contentString: (Hepatitis B dose 1 Create)
category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })
priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })
Hepatitis B dose 2: Provision of hepatitis B dose 2 Trigger event: First hepatitis B dose from the primary series was administered Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 1 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") Create condition: The following option is considered appropriate: a 3-dose schedule with the first dose (monovalent) being given at birth and the second and third (monovalent or as part of a combined vaccine) given at the same time as the first and third doses of DTP-containing vaccine. The interval between doses should be at least 4 weeks.
If: Applicability: Hepatitis B dose 2 (Hepatitis B dose 2)
Then: Definition: IMMZ.D2.DT.CR
Dynamic Values:
status: ('active')
payload.contentString: (Hepatitis B dose 2 Create)
category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })
priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })
Hepatitis B dose 3: Provision of hepatitis B dose 3 for low-birth-weight and premature infants Trigger event: Second hepatitis B dose from the primary series was administered. Client's weight at birth was less than 2000 g or client was a premature infant Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines") = 2 and ("Birth weight in grams" < 2000) or ("Preterm birth" = TRUE) Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") Create condition: A birth dose of hepatitis B-containing vaccine can be given to low-birth-weight (< 2000 g) and premature infants. For these infants, the birth dose should not count as part of the primary 3-dose series; the 3 doses of the standard primary series should be given according to the national vaccination schedule.
If: Applicability: Hepatitis B dose 3 (Hepatitis B dose 3)
Then: Definition: IMMZ.D2.DT.CR
Dynamic Values:
status: ('active')
payload.contentString: (Hepatitis B dose 3 Create)
category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })
priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })

Source

{
  "resourceType": "PlanDefinition",
  "id": "IMMZD18SHepatitisB3Dose",
  "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/uv/cpg/StructureDefinition/cpg-knowledgeCapability",
      "valueCode": "computable"
    }
  ],
  "url": "http://smart.who.int/immunizations/PlanDefinition/IMMZD18SHepatitisB3Dose",
  "version": "0.2.0",
  "name": "IMMZD18SHepatitisB3Dose",
  "title": "IMMZ.D18.S.Hepatitis B.3-dose schedule",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code": "eca-rule"
      }
    ]
  },
  "status": "draft",
  "experimental": false,
  "date": "2025-07-25T21:56:21+00:00",
  "publisher": "WHO",
  "contact": [
    {
      "name": "WHO",
      "telecom": [
        {
          "system": "url",
          "value": "http://who.int"
        }
      ]
    }
  ],
  "description": "IMMZ.D18.S.Hepatitis B.3-dose schedule\n3-dose schedule (birth dose + 2 primary series doses), on-time start",
  "relatedArtifact": [
    {
      "type": "citation",
      "citation": "WHO recommendations for routine immunization - summary tables (January 2025)"
    }
  ],
  "library": [
    "http://smart.who.int/immunizations/Library/IMMZD18SHepatitisB3DoseLogic"
  ],
  "action": [
    {
      "title": "Hepatitis B dose 1",
      "description": "Provision of hepatitis B dose 1\nTrigger event: Child's birth\nTrigger date: \"Date of birth\"\nCreate condition: The following option is considered appropriate: a 3-dose schedule with the first dose (monovalent) being given at birth and the second and third (monovalent or as part of a combined vaccine) given at the same time as the first and third doses of DTP-containing vaccine.\nThe interval between doses should be at least 4 weeks.",
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Hepatitis B dose 1",
            "language": "text/cql-identifier",
            "expression": "Hepatitis B dose 1"
          }
        }
      ],
      "definitionCanonical": "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
      "dynamicValue": [
        {
          "path": "status",
          "expression": {
            "language": "text/cql-expression",
            "expression": "'active'"
          }
        },
        {
          "path": "payload.contentString",
          "expression": {
            "language": "text/cql-identifier",
            "expression": "Hepatitis B dose 1 Create"
          }
        },
        {
          "path": "category.coding",
          "expression": {
            "description": "Category of communication",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
          }
        },
        {
          "path": "priority",
          "expression": {
            "description": "Alert priority",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
          }
        }
      ]
    },
    {
      "title": "Hepatitis B dose 2",
      "description": "Provision of hepatitis B dose 2\nTrigger event: First hepatitis B dose from the primary series was administered\nCount of vaccines administered (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\" and \"Type of dose\"= \"Primary series\") = 1\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\")\nCreate condition: The following option is considered appropriate: a 3-dose schedule with the first dose (monovalent) being given at birth and the second and third (monovalent or as part of a combined vaccine) given at the same time as the first and third doses of DTP-containing vaccine.\nThe interval between doses should be at least 4 weeks.",
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Hepatitis B dose 2",
            "language": "text/cql-identifier",
            "expression": "Hepatitis B dose 2"
          }
        }
      ],
      "definitionCanonical": "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
      "dynamicValue": [
        {
          "path": "status",
          "expression": {
            "language": "text/cql-expression",
            "expression": "'active'"
          }
        },
        {
          "path": "payload.contentString",
          "expression": {
            "language": "text/cql-identifier",
            "expression": "Hepatitis B dose 2 Create"
          }
        },
        {
          "path": "category.coding",
          "expression": {
            "description": "Category of communication",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
          }
        },
        {
          "path": "priority",
          "expression": {
            "description": "Alert priority",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
          }
        }
      ]
    },
    {
      "title": "Hepatitis B dose 3",
      "description": "Provision of hepatitis B dose 3 for low-birth-weight and premature infants\nTrigger event: Second hepatitis B dose from the primary series was administered. Client's weight at birth was less than 2000 g or client was a premature infant\nCount of vaccines administered (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\") = 2 and (\"Birth weight in grams\"  < 2000) or (\"Preterm birth\" =  TRUE)\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\")\nCreate condition: A birth dose of hepatitis B-containing vaccine can be given to low-birth-weight (< 2000 g) and premature infants. For these infants, the birth dose should not count as part of the primary 3-dose series; the 3 doses of the standard primary series should be given according to the national vaccination schedule.",
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Hepatitis B dose 3",
            "language": "text/cql-identifier",
            "expression": "Hepatitis B dose 3"
          }
        }
      ],
      "definitionCanonical": "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
      "dynamicValue": [
        {
          "path": "status",
          "expression": {
            "language": "text/cql-expression",
            "expression": "'active'"
          }
        },
        {
          "path": "payload.contentString",
          "expression": {
            "language": "text/cql-identifier",
            "expression": "Hepatitis B dose 3 Create"
          }
        },
        {
          "path": "category.coding",
          "expression": {
            "description": "Category of communication",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
          }
        },
        {
          "path": "priority",
          "expression": {
            "description": "Alert priority",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
          }
        }
      ]
    }
  ]
}