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

FHIR IG Statistics: StructureDefinition/VaccineDetails

Packagesmart.who.int.trust-phw
TypeStructureDefinition
IdVaccineDetails
FHIR VersionR4
Sourcehttp://smart.who.int/trust-phw/https://build.fhir.org/ig/WorldHealthOrganization/smart-trust-phw/StructureDefinition-VaccineDetails.html
URLhttp://smart.who.int/trust-phw/StructureDefinition/VaccineDetails
Version0.1.0
Statusactive
Date2025-07-08T11:27:10+00:00
NameVaccineDetails
TitleDVC - Vaccine Details
Realmuv
Authoritywho
DescriptionVaccine Data elements for the Digital Vaccination Certificates
Typehttp://smart.who.int/trust-phw/StructureDefinition/VaccineDetails
Kindlogical

Resources that use this resource

StructureDefinition
DVCDVC
PreQualVaccineDetailsPreQual - Vaccine Details
VaccineDetailsSDDVC Vaccine Details with Selective Disclosure

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: StructureDefinition VaccineDetails

NameFlagsCard.TypeDescription & Constraintsdoco
.. VaccineDetails C0..*BaseDVC - Vaccine Details
Instances of this logical model can be the target of a Reference
Constraints: must-have-issuer-or-clinician
... productID 1..1CodingVaccine Product
... date 1..1dateDate
... issuer 0..1Reference(Organization)Issuing Organization
... clinicianName 0..1stringName of supervising clinician
... batchNo 1..1CodeableConceptBatch No
... validityPeriod 0..1PeriodCertificate validity period

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "VaccineDetails",
  "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/trust-phw/StructureDefinition/VaccineDetails",
  "version": "0.1.0",
  "name": "VaccineDetails",
  "title": "DVC - Vaccine Details",
  "status": "active",
  "experimental": true,
  "date": "2025-07-08T11:27:10+00:00",
  "publisher": "WHO",
  "contact": [
    {
      "name": "WHO",
      "telecom": [
        {
          "system": "url",
          "value": "http://who.int"
        }
      ]
    }
  ],
  "description": "Vaccine Data elements for the Digital Vaccination Certificates",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "http://smart.who.int/trust-phw/StructureDefinition/VaccineDetails",
  "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": "VaccineDetails",
        "path": "VaccineDetails",
        "short": "DVC - Vaccine Details",
        "definition": "Vaccine Data elements for the Digital Vaccination Certificates",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "must-have-issuer-or-clinician",
            "severity": "error",
            "human": "Either issuer or clinicianName must be present",
            "expression": "issuer.exists() or clinicianName.exists()",
            "source": "http://smart.who.int/trust-phw/StructureDefinition/VaccineDetails"
          }
        ],
        "isModifier": false
      },
      {
        "id": "VaccineDetails.productID",
        "path": "VaccineDetails.productID",
        "short": "Vaccine Product",
        "definition": "Vaccine product information (note: use InventoryItem in FHIR R6)",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VaccineDetails.productID",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Coding"
          }
        ]
      },
      {
        "id": "VaccineDetails.date",
        "path": "VaccineDetails.date",
        "short": "Date",
        "definition": "Date of vaccine",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VaccineDetails.date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "VaccineDetails.issuer",
        "path": "VaccineDetails.issuer",
        "short": "Issuing Organization",
        "definition": "Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VaccineDetails.issuer",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id": "VaccineDetails.clinicianName",
        "path": "VaccineDetails.clinicianName",
        "short": "Name of supervising clinician",
        "definition": "Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VaccineDetails.clinicianName",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VaccineDetails.batchNo",
        "path": "VaccineDetails.batchNo",
        "short": "Batch No",
        "definition": "Batch No",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VaccineDetails.batchNo",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "VaccineDetails.validityPeriod",
        "path": "VaccineDetails.validityPeriod",
        "short": "Certificate validity period",
        "definition": "Certificate validity period",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VaccineDetails.validityPeriod",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "VaccineDetails",
        "path": "VaccineDetails",
        "short": "DVC - Vaccine Details",
        "definition": "Vaccine Data elements for the Digital Vaccination Certificates",
        "constraint": [
          {
            "key": "must-have-issuer-or-clinician",
            "severity": "error",
            "human": "Either issuer or clinicianName must be present",
            "expression": "issuer.exists() or clinicianName.exists()",
            "source": "http://smart.who.int/trust-phw/StructureDefinition/VaccineDetails"
          }
        ]
      },
      {
        "id": "VaccineDetails.productID",
        "path": "VaccineDetails.productID",
        "short": "Vaccine Product",
        "definition": "Vaccine product information (note: use InventoryItem in FHIR R6)",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Coding"
          }
        ]
      },
      {
        "id": "VaccineDetails.date",
        "path": "VaccineDetails.date",
        "short": "Date",
        "definition": "Date of vaccine",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "VaccineDetails.issuer",
        "path": "VaccineDetails.issuer",
        "short": "Issuing Organization",
        "definition": "Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id": "VaccineDetails.clinicianName",
        "path": "VaccineDetails.clinicianName",
        "short": "Name of supervising clinician",
        "definition": "Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VaccineDetails.batchNo",
        "path": "VaccineDetails.batchNo",
        "short": "Batch No",
        "definition": "Batch No",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "VaccineDetails.validityPeriod",
        "path": "VaccineDetails.validityPeriod",
        "short": "Certificate validity period",
        "definition": "Certificate validity period",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      }
    ]
  }
}