{
  "resourceType": "StructureDefinition",
  "id": "biobankcy-sd-immunization",
  "url": "http://ig.biobank.cy/fhir/StructureDefinition/biobankcy-sd-immunization",
  "name": "BIOBANKCYImmunization",
  "title": "Profile: Immunization (biobank.cy)",
  "status": "draft",
  "experimental": true,
  "date": "2022-04-18",
  "publisher": "biobank.cy",
  "contact": [
    {
      "name": "Molecular Medicine Research Center (MMRC)",
      "telecom": [
        {
          "system": "email",
          "value": "biobank@ucy.ac.cy",
          "use": "work"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Immunization",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Immunization.extension:vaccineMedicinalProduct",
        "path": "Immunization.extension",
        "sliceName": "vaccineMedicinalProduct",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-medicinalproductdefinition"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Immunization.extension:vaccineMedicinalProduct.extension:strength",
        "path": "Immunization.extension.extension",
        "sliceName": "strength",
        "max": "0"
      },
      {
        "id": "Immunization.extension:vaccineMedicinalProduct.extension:routeOfAdministration",
        "path": "Immunization.extension.extension",
        "sliceName": "routeOfAdministration",
        "max": "0"
      },
      {
        "id": "Immunization.extension:vaccineMedicinalProduct.url",
        "path": "Immunization.extension.url",
        "fixedUri": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-medicinalproductdefinition"
      },
      {
        "id": "Immunization.extension:marketingAuthorizationHolder",
        "path": "Immunization.extension",
        "sliceName": "marketingAuthorizationHolder",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-marketingauthorizationholder"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Immunization.extension:marketingAuthorizationHolder.url",
        "path": "Immunization.extension.url",
        "fixedUri": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-marketingauthorizationholder"
      },
      {
        "id": "Immunization.identifier",
        "path": "Immunization.identifier",
        "comment": "Not to be used for biobank.cy"
      },
      {
        "id": "Immunization.identifier.assigner.identifier.type",
        "path": "Immunization.identifier.assigner.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.identifier.assigner.identifier.type.coding.system",
        "path": "Immunization.identifier.assigner.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.identifier.assigner.identifier.type.coding.code",
        "path": "Immunization.identifier.assigner.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.identifier.assigner.identifier.type.coding.display",
        "path": "Immunization.identifier.assigner.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.status",
        "path": "Immunization.status",
        "mustSupport": true
      },
      {
        "id": "Immunization.statusReason",
        "path": "Immunization.statusReason",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.vaccineCode",
        "path": "Immunization.vaccineCode",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.vaccineCode.coding",
        "path": "Immunization.vaccineCode.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "$this"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Immunization.vaccineCode.coding.system",
        "path": "Immunization.vaccineCode.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.code",
        "path": "Immunization.vaccineCode.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.display",
        "path": "Immunization.vaccineCode.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding:eHDSIVaccine",
        "path": "Immunization.vaccineCode.coding",
        "sliceName": "eHDSIVaccine",
        "definition": "A reference to a vaccine code as defined by the eHDSI in Master Value Catalogue. The value set includes codes from http://snomed.info/sct and http://www.whocc.no/atc.",
        "max": "1",
        "binding": {
          "strength": "required",
          "valueSet": "http://ig.ehealth4u.eu/fhir/ValueSet/cyehr-vs-ehdsivaccine"
        }
      },
      {
        "id": "Immunization.vaccineCode.coding:eHDSIVaccine.system",
        "path": "Immunization.vaccineCode.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding:eHDSIVaccine.code",
        "path": "Immunization.vaccineCode.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding:eHDSIVaccine.display",
        "path": "Immunization.vaccineCode.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunizationIPS",
        "path": "Immunization.vaccineCode.coding",
        "sliceName": "absentOrUnknownImmunizationIPS",
        "max": "1",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips"
        }
      },
      {
        "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunizationIPS.system",
        "path": "Immunization.vaccineCode.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunizationIPS.code",
        "path": "Immunization.vaccineCode.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunizationIPS.display",
        "path": "Immunization.vaccineCode.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.patient",
        "path": "Immunization.patient",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://ig.biobank.cy/fhir/StructureDefinition/biobankcy-sd-donor",
              "http://ig.biobank.cy/fhir/StructureDefinition/biobankcy-sd-citizen"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.patient.reference",
        "path": "Immunization.patient.reference",
        "min": 1
      },
      {
        "id": "Immunization.patient.identifier.type",
        "path": "Immunization.patient.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.patient.identifier.type.coding.system",
        "path": "Immunization.patient.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.patient.identifier.type.coding.code",
        "path": "Immunization.patient.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.patient.identifier.type.coding.display",
        "path": "Immunization.patient.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.patient.identifier.assigner.identifier.type",
        "path": "Immunization.patient.identifier.assigner.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.patient.identifier.assigner.identifier.type.coding.system",
        "path": "Immunization.patient.identifier.assigner.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.patient.identifier.assigner.identifier.type.coding.code",
        "path": "Immunization.patient.identifier.assigner.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.patient.identifier.assigner.identifier.type.coding.display",
        "path": "Immunization.patient.identifier.assigner.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.encounter",
        "path": "Immunization.encounter",
        "definition": "The Encounter during which this Immunization resource was captured as part of the questionnaire/interview process involving a donor/citizen receiving services from the biobank. In case this resource is retrieved from an outside system (e.g. national EHR system) then don't use this element.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Encounter",
              "http://ig.biobank.cy/fhir/StructureDefinition/biobankcy-sd-visit"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.encounter.reference",
        "path": "Immunization.encounter.reference",
        "min": 1
      },
      {
        "id": "Immunization.encounter.identifier.type",
        "path": "Immunization.encounter.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.encounter.identifier.type.coding.system",
        "path": "Immunization.encounter.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.encounter.identifier.type.coding.code",
        "path": "Immunization.encounter.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.encounter.identifier.type.coding.display",
        "path": "Immunization.encounter.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.encounter.identifier.assigner.identifier.type",
        "path": "Immunization.encounter.identifier.assigner.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.encounter.identifier.assigner.identifier.type.coding.system",
        "path": "Immunization.encounter.identifier.assigner.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.encounter.identifier.assigner.identifier.type.coding.code",
        "path": "Immunization.encounter.identifier.assigner.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.encounter.identifier.assigner.identifier.type.coding.display",
        "path": "Immunization.encounter.identifier.assigner.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.occurrence[x]",
        "path": "Immunization.occurrence[x]",
        "mustSupport": true
      },
      {
        "id": "Immunization.reportOrigin",
        "path": "Immunization.reportOrigin",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.reportOrigin.coding.system",
        "path": "Immunization.reportOrigin.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.reportOrigin.coding.code",
        "path": "Immunization.reportOrigin.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.reportOrigin.coding.display",
        "path": "Immunization.reportOrigin.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.manufacturer",
        "path": "Immunization.manufacturer",
        "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.lotNumber",
        "path": "Immunization.lotNumber",
        "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.site",
        "path": "Immunization.site",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://hl7.org/fhir/ValueSet/body-site"
        }
      },
      {
        "id": "Immunization.site.coding.system",
        "path": "Immunization.site.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.site.coding.code",
        "path": "Immunization.site.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.site.coding.display",
        "path": "Immunization.site.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.route",
        "path": "Immunization.route",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.route.coding",
        "path": "Immunization.route.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "$this"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Immunization.route.coding.system",
        "path": "Immunization.route.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.route.coding.code",
        "path": "Immunization.route.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.route.coding.display",
        "path": "Immunization.route.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.route.coding:eHDSIRouteOfAdministration",
        "path": "Immunization.route.coding",
        "sliceName": "eHDSIRouteOfAdministration",
        "definition": "A reference to a code defined by a terminology system.\r\n\r\nA reference to a code defined by EDQM as defined by eHDSI in Master Value Catalogue for eHDSIRouteofAdministration.",
        "binding": {
          "strength": "required",
          "valueSet": "http://ig.ehealth4u.eu/fhir/ValueSet/cyehr-vs-ehdsirouteofadministration"
        }
      },
      {
        "id": "Immunization.route.coding:eHDSIRouteOfAdministration.system",
        "path": "Immunization.route.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.route.coding:eHDSIRouteOfAdministration.code",
        "path": "Immunization.route.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.route.coding:eHDSIRouteOfAdministration.display",
        "path": "Immunization.route.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.doseQuantity",
        "path": "Immunization.doseQuantity",
        "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.performer",
        "path": "Immunization.performer",
        "definition": "Indicates who performed the immunization event.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.performer.function",
        "path": "Immunization.performer.function",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.reasonCode",
        "path": "Immunization.reasonCode",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.reasonReference",
        "path": "Immunization.reasonReference",
        "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.isSubpotent",
        "path": "Immunization.isSubpotent",
        "comment": "Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.subpotentReason",
        "path": "Immunization.subpotentReason",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.education",
        "path": "Immunization.education",
        "comment": "Not to be used for biobank.cy"
      },
      {
        "id": "Immunization.programEligibility",
        "path": "Immunization.programEligibility",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.fundingSource",
        "path": "Immunization.fundingSource",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.reaction",
        "path": "Immunization.reaction",
        "comment": "A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.\r\n\r\nNot to be used for biobank.cy"
      },
      {
        "id": "Immunization.protocolApplied",
        "path": "Immunization.protocolApplied",
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.type",
        "path": "Immunization.protocolApplied.authority.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.type.coding.system",
        "path": "Immunization.protocolApplied.authority.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.type.coding.code",
        "path": "Immunization.protocolApplied.authority.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.type.coding.display",
        "path": "Immunization.protocolApplied.authority.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type",
        "path": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type.coding.system",
        "path": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type.coding.code",
        "path": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type.coding.display",
        "path": "Immunization.protocolApplied.authority.identifier.assigner.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.targetDisease",
        "path": "Immunization.protocolApplied.targetDisease",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "$this"
            }
          ],
          "rules": "open"
        },
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "https://hl7.org/fhir/uv/ips/ValueSet-target-diseases-snomed-ct-ips-free-set.html"
        }
      },
      {
        "id": "Immunization.protocolApplied.targetDisease:TargetDisease",
        "path": "Immunization.protocolApplied.targetDisease",
        "sliceName": "TargetDisease",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://hl7.org/fhir/uv/ips/ValueSet-target-diseases-uv-ips.html"
        }
      },
      {
        "id": "Immunization.protocolApplied.targetDisease:TargetDisease.coding.system",
        "path": "Immunization.protocolApplied.targetDisease.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.targetDisease:TargetDisease.coding.code",
        "path": "Immunization.protocolApplied.targetDisease.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.targetDisease:TargetDisease.coding.display",
        "path": "Immunization.protocolApplied.targetDisease.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.protocolApplied.doseNumber[x]",
        "path": "Immunization.protocolApplied.doseNumber[x]",
        "mustSupport": true
      }
    ]
  }
}