{
  "resourceType": "StructureDefinition",
  "id": "4d65b2cd-9382-4931-949c-ab11c3924e08",
  "meta": {
    "versionId": "14",
    "lastUpdated": "2022-08-19T20:53:37.2989433+00:00"
  },
  "url": "http://ehealth.bc.ca/fhir/StructureDefinition/Immunization",
  "name": "Immunization",
  "status": "draft",
  "date": "2022-03-07T18:53:15.0439773+00:00",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "cda",
      "uri": "http://hl7.org/v3/cda",
      "name": "CDA (R2)"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Immunization",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Immunization.id",
        "path": "Immunization.id",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-cznSub",
            "map": "EXTERNAL_IMMS_ID"
          }
        ]
      },
      {
        "id": "Immunization.meta",
        "path": "Immunization.meta",
        "min": 1
      },
      {
        "id": "Immunization.meta.id",
        "path": "Immunization.meta.id",
        "max": "0"
      },
      {
        "id": "Immunization.meta.versionId",
        "path": "Immunization.meta.versionId",
        "fixedId": "2022.01"
      },
      {
        "id": "Immunization.meta.lastUpdated",
        "path": "Immunization.meta.lastUpdated",
        "max": "0"
      },
      {
        "id": "Immunization.meta.source",
        "path": "Immunization.meta.source",
        "max": "0"
      },
      {
        "id": "Immunization.meta.profile",
        "path": "Immunization.meta.profile",
        "comment": "Apply 'http://ehealth.bc.ca/fhir/StructureDefinition/Immunization'",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Immunization.meta.security",
        "path": "Immunization.meta.security",
        "max": "0"
      },
      {
        "id": "Immunization.meta.tag",
        "path": "Immunization.meta.tag",
        "max": "0"
      },
      {
        "id": "Immunization.implicitRules",
        "path": "Immunization.implicitRules",
        "max": "0"
      },
      {
        "id": "Immunization.language",
        "path": "Immunization.language",
        "max": "0"
      },
      {
        "id": "Immunization.text",
        "path": "Immunization.text",
        "max": "0"
      },
      {
        "id": "Immunization.contained",
        "path": "Immunization.contained",
        "max": "0"
      },
      {
        "id": "Immunization.identifier",
        "path": "Immunization.identifier",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Immunization.identifier.id",
        "path": "Immunization.identifier.id",
        "max": "0"
      },
      {
        "id": "Immunization.identifier.use",
        "path": "Immunization.identifier.use",
        "max": "0"
      },
      {
        "id": "Immunization.identifier.type.id",
        "path": "Immunization.identifier.type.id",
        "max": "0"
      },
      {
        "id": "Immunization.identifier.type.coding",
        "path": "Immunization.identifier.type.coding",
        "max": "0"
      },
      {
        "id": "Immunization.identifier.type.text",
        "path": "Immunization.identifier.type.text",
        "comment": "Hardcode \"CZNSUBIMMSID\"",
        "min": 1
      },
      {
        "id": "Immunization.identifier.system",
        "path": "Immunization.identifier.system",
        "comment": "\"https://ehealth.bc.ca/NamingSystem/ca-bc-citizen-submission\"",
        "min": 1
      },
      {
        "id": "Immunization.identifier.value",
        "path": "Immunization.identifier.value",
        "comment": "Prefix \"cznsub\" + \"-\" + (guid of resourceBundle.id)  e.g. \"cznsub-ea188d28-c942-41f6-831b-0aedcb22d76a\".  If more than one immz record, add suffix \"-02\"  e.g. \"cznsub-ea188d28-c942-41f6-831b-0aedcb22d76a-02\".",
        "min": 1
      },
      {
        "id": "Immunization.identifier.period",
        "path": "Immunization.identifier.period",
        "max": "0"
      },
      {
        "id": "Immunization.identifier.assigner",
        "path": "Immunization.identifier.assigner",
        "max": "0"
      },
      {
        "id": "Immunization.status",
        "path": "Immunization.status",
        "comment": "Hardcode \"completed\""
      },
      {
        "id": "Immunization.statusReason",
        "path": "Immunization.statusReason",
        "max": "0"
      },
      {
        "id": "Immunization.vaccineCode.id",
        "path": "Immunization.vaccineCode.id",
        "max": "0"
      },
      {
        "id": "Immunization.vaccineCode.coding",
        "path": "Immunization.vaccineCode.coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Immunization.vaccineCode.coding.id",
        "path": "Immunization.vaccineCode.coding.id",
        "max": "0"
      },
      {
        "id": "Immunization.vaccineCode.coding.system",
        "path": "Immunization.vaccineCode.coding.system",
        "comment": "Hardcode: \"http://snomed.info/sct”",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.version",
        "path": "Immunization.vaccineCode.coding.version",
        "max": "0"
      },
      {
        "id": "Immunization.vaccineCode.coding.code",
        "path": "Immunization.vaccineCode.coding.code",
        "comment": "e.g. \"29291000087103\" (Agent SNOMED)  or Trade Name code",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.display",
        "path": "Immunization.vaccineCode.coding.display",
        "comment": "e.g.\"COVID-19 Spike Protein Subunit\" or Trade Name",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.userSelected",
        "path": "Immunization.vaccineCode.coding.userSelected",
        "comment": "Hardcode: \"http://snomed.info/sct”",
        "max": "0"
      },
      {
        "id": "Immunization.vaccineCode.text",
        "path": "Immunization.vaccineCode.text",
        "max": "0"
      },
      {
        "id": "Immunization.patient.id",
        "path": "Immunization.patient.id",
        "max": "0"
      },
      {
        "id": "Immunization.patient.reference",
        "path": "Immunization.patient.reference",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-cznSub",
            "map": "fullURL + \"Patient/\" + (Patient ID)",
            "comment": "http://ehealth.bc.ca/cznSub/fhir/"
          }
        ]
      },
      {
        "id": "Immunization.patient.type",
        "path": "Immunization.patient.type",
        "max": "0"
      },
      {
        "id": "Immunization.patient.identifier",
        "path": "Immunization.patient.identifier",
        "max": "0"
      },
      {
        "id": "Immunization.patient.display",
        "path": "Immunization.patient.display",
        "max": "0"
      },
      {
        "id": "Immunization.encounter",
        "path": "Immunization.encounter",
        "max": "0"
      },
      {
        "id": "Immunization.occurrence[x]",
        "path": "Immunization.occurrence[x]",
        "comment": "If Day is missing, use last day of estimated month.   If year and/or month is missing, do not send imms record.  Date format: yyyy-mm-dd.",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Immunization.occurrence[x].id",
        "path": "Immunization.occurrence[x].id",
        "max": "0"
      },
      {
        "id": "Immunization.occurrence[x].extension",
        "path": "Immunization.occurrence[x].extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 0
      },
      {
        "id": "Immunization.occurrence[x].extension:_occurrenceDateTime",
        "path": "Immunization.occurrence[x].extension",
        "sliceName": "_occurrenceDateTime",
        "short": "Estimated Flag",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Immunization.recorded",
        "path": "Immunization.recorded",
        "max": "0"
      },
      {
        "id": "Immunization.primarySource",
        "path": "Immunization.primarySource",
        "comment": "Hardcode \"false\"",
        "min": 1
      },
      {
        "id": "Immunization.reportOrigin.id",
        "path": "Immunization.reportOrigin.id",
        "max": "0"
      },
      {
        "id": "Immunization.reportOrigin.coding.id",
        "path": "Immunization.reportOrigin.coding.id",
        "max": "0"
      },
      {
        "id": "Immunization.reportOrigin.coding.system",
        "path": "Immunization.reportOrigin.coding.system",
        "comment": "Hardcode: \"http://snomed.info/sct”",
        "min": 1
      },
      {
        "id": "Immunization.reportOrigin.coding.version",
        "path": "Immunization.reportOrigin.coding.version",
        "max": "0"
      },
      {
        "id": "Immunization.reportOrigin.coding.code",
        "path": "Immunization.reportOrigin.coding.code",
        "comment": "Hardcode : \"116154003\"",
        "min": 1
      },
      {
        "id": "Immunization.reportOrigin.coding.display",
        "path": "Immunization.reportOrigin.coding.display",
        "comment": "Hardcode: \"Personal Record\"",
        "min": 1
      },
      {
        "id": "Immunization.reportOrigin.coding.userSelected",
        "path": "Immunization.reportOrigin.coding.userSelected",
        "max": "0"
      },
      {
        "id": "Immunization.reportOrigin.text",
        "path": "Immunization.reportOrigin.text",
        "max": "0"
      },
      {
        "id": "Immunization.location.id",
        "path": "Immunization.location.id",
        "max": "0"
      },
      {
        "id": "Immunization.location.reference",
        "path": "Immunization.location.reference",
        "comment": "fullURL + See Mappings.",
        "min": 1,
        "mapping": [
          {
            "identity": "source-cznSub-sdl-dropdownlist",
            "map": "fullURL+\"Location/\"+(SDL_ID)+\"org\"+(BRANCH_ID)",
            "comment": "http://ehealth.bc.ca/cznSub/fhir"
          },
          {
            "identity": "source-cznSub-sdl-NOTdropdownlist",
            "map": "fullURL+\"Location/\"+(UNKn)+\"org3268\"",
            "comment": "n=1,2,3,4 etc; http://ehealth.bc.ca/cznSub/fhir"
          }
        ]
      },
      {
        "id": "Immunization.location.type",
        "path": "Immunization.location.type",
        "max": "0"
      },
      {
        "id": "Immunization.location.identifier",
        "path": "Immunization.location.identifier",
        "max": "0"
      },
      {
        "id": "Immunization.location.display",
        "path": "Immunization.location.display",
        "max": "0"
      },
      {
        "id": "Immunization.manufacturer",
        "path": "Immunization.manufacturer",
        "max": "0"
      },
      {
        "id": "Immunization.expirationDate",
        "path": "Immunization.expirationDate",
        "max": "0"
      },
      {
        "id": "Immunization.site.id",
        "path": "Immunization.site.id",
        "max": "0"
      },
      {
        "id": "Immunization.site.coding.id",
        "path": "Immunization.site.coding.id",
        "max": "0"
      },
      {
        "id": "Immunization.site.coding.system",
        "path": "Immunization.site.coding.system",
        "comment": "Hardcode: \"http://snomed.info/sct”"
      },
      {
        "id": "Immunization.site.coding.version",
        "path": "Immunization.site.coding.version",
        "max": "0"
      },
      {
        "id": "Immunization.site.coding.code",
        "path": "Immunization.site.coding.code",
        "comment": "e.g. \"368208006\""
      },
      {
        "id": "Immunization.site.coding.display",
        "path": "Immunization.site.coding.display",
        "comment": "e.g. \"Arm - Left\""
      },
      {
        "id": "Immunization.site.coding.userSelected",
        "path": "Immunization.site.coding.userSelected",
        "max": "0"
      },
      {
        "id": "Immunization.route",
        "path": "Immunization.route",
        "max": "0"
      },
      {
        "id": "Immunization.doseQuantity",
        "path": "Immunization.doseQuantity",
        "max": "0"
      },
      {
        "id": "Immunization.performer.id",
        "path": "Immunization.performer.id",
        "max": "0"
      },
      {
        "id": "Immunization.performer.function.coding.id",
        "path": "Immunization.performer.function.coding.id",
        "max": "0"
      },
      {
        "id": "Immunization.performer.function.coding.system",
        "path": "Immunization.performer.function.coding.system",
        "comment": "Hardcode: \"http://terminology.hl7.org/CodeSystem/v2-0443”"
      },
      {
        "id": "Immunization.performer.function.coding.version",
        "path": "Immunization.performer.function.coding.version",
        "max": "0"
      },
      {
        "id": "Immunization.performer.function.coding.code",
        "path": "Immunization.performer.function.coding.code",
        "comment": "Hardcode: \"AP\"",
        "min": 1
      },
      {
        "id": "Immunization.performer.function.coding.display",
        "path": "Immunization.performer.function.coding.display",
        "comment": "Hardcode: \"Administering Provider\"",
        "min": 1
      },
      {
        "id": "Immunization.performer.function.coding.userSelected",
        "path": "Immunization.performer.function.coding.userSelected",
        "max": "0"
      },
      {
        "id": "Immunization.performer.function.text",
        "path": "Immunization.performer.function.text",
        "max": "0"
      },
      {
        "id": "Immunization.performer.actor.id",
        "path": "Immunization.performer.actor.id",
        "max": "0"
      },
      {
        "id": "Immunization.performer.actor.reference",
        "path": "Immunization.performer.actor.reference",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-CznSub",
            "map": "\"Practitioner/Performer1\""
          }
        ]
      },
      {
        "id": "Immunization.performer.actor.type",
        "path": "Immunization.performer.actor.type",
        "max": "0"
      },
      {
        "id": "Immunization.performer.actor.identifier",
        "path": "Immunization.performer.actor.identifier",
        "max": "0"
      },
      {
        "id": "Immunization.performer.actor.display",
        "path": "Immunization.performer.actor.display",
        "max": "0"
      },
      {
        "id": "Immunization.note.id",
        "path": "Immunization.note.id",
        "max": "0"
      },
      {
        "id": "Immunization.note.author[x]",
        "path": "Immunization.note.author[x]",
        "max": "0"
      },
      {
        "id": "Immunization.note.time",
        "path": "Immunization.note.time",
        "max": "0"
      },
      {
        "id": "Immunization.note.text",
        "path": "Immunization.note.text",
        "comment": "1. Client immunization record received via Citizen Submission V2, details verified by reviewing client submitted image and entered into the clients record. \r\n2. Tradename: (product name) - a.  if Other Vaccine or b. If Trade names in ('Comirnaty', 'Spikevax', 'Vaxzevria')\r\n3. Lot #: (lot number)\r\n4. Clinic Location:  (country vaccinated/province vaccinated ) \r\n5. (Comments or any other pertinent details provided in the photo/document that is not captured in a discrete field in Historical Imms)\r\nPHIX BCY_CZNSUB (Citizen Submission): Ref # (resourceBundle.id)"
      },
      {
        "id": "Immunization.reasonCode",
        "path": "Immunization.reasonCode",
        "max": "0"
      },
      {
        "id": "Immunization.reasonReference",
        "path": "Immunization.reasonReference",
        "max": "0"
      },
      {
        "id": "Immunization.isSubpotent",
        "path": "Immunization.isSubpotent",
        "max": "0"
      },
      {
        "id": "Immunization.subpotentReason",
        "path": "Immunization.subpotentReason",
        "max": "0"
      },
      {
        "id": "Immunization.education",
        "path": "Immunization.education",
        "max": "0"
      },
      {
        "id": "Immunization.programEligibility",
        "path": "Immunization.programEligibility",
        "max": "0"
      },
      {
        "id": "Immunization.fundingSource",
        "path": "Immunization.fundingSource",
        "max": "0"
      },
      {
        "id": "Immunization.reaction",
        "path": "Immunization.reaction",
        "max": "0"
      },
      {
        "id": "Immunization.protocolApplied.id",
        "path": "Immunization.protocolApplied.id",
        "max": "0"
      },
      {
        "id": "Immunization.protocolApplied.series",
        "path": "Immunization.protocolApplied.series",
        "max": "0"
      },
      {
        "id": "Immunization.protocolApplied.authority",
        "path": "Immunization.protocolApplied.authority",
        "max": "0"
      },
      {
        "id": "Immunization.protocolApplied.targetDisease",
        "path": "Immunization.protocolApplied.targetDisease",
        "max": "0"
      },
      {
        "id": "Immunization.protocolApplied.doseNumber[x]",
        "path": "Immunization.protocolApplied.doseNumber[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Immunization.protocolApplied.seriesDoses[x]",
        "path": "Immunization.protocolApplied.seriesDoses[x]",
        "max": "0"
      }
    ]
  }
}