{
  "resourceType": "StructureDefinition",
  "id": "Profile-immunization",
  "meta": {
    "lastUpdated": "2024-10-17T17:19:03.0939134+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Clinical.Medications"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "patient"
    }
  ],
  "url": "https://simplifier.net/omd-cdss/immunizationprofile",
  "version": "0.1.10",
  "name": "ImmunizationProfile",
  "title": "Immunization Profile",
  "status": "active",
  "date": "2021-11-09T22:40:48.4530491+00:00",
  "publisher": "OMD",
  "description": "Immunization Profile",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "CDSS5.1",
      "uri": "www.ontariomd.com",
      "name": "CDS-S 5.1"
    },
    {
      "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",
        "short": "Immunization RID"
      },
      {
        "id": "Immunization.identifier",
        "path": "Immunization.identifier",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Immunization.identifier.system",
        "path": "Immunization.identifier.system",
        "min": 1,
        "patternUri": "http://ehealthontario.ca/fhir/NamingSystem/ca-on-covax-imm-id"
      },
      {
        "id": "Immunization.identifier.value",
        "path": "Immunization.identifier.value",
        "min": 1
      },
      {
        "id": "Immunization.status",
        "path": "Immunization.status",
        "short": "completed | not-done",
        "definition": "BASE RESOURCE DEFINITION:\r\nIndicates the current status of the immunization event.\r\n\r\nCDS-S PROFILE DEFINITION:\r\nA flag to indicate whether the immunization was administered or refused.",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.011",
            "comment": "Refused Indicator"
          }
        ]
      },
      {
        "id": "Immunization.statusReason",
        "path": "Immunization.statusReason",
        "comment": "Usage Notes: a reason should be provided if the status is 'not-done'.",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/immunizationstatusreason"
        }
      },
      {
        "id": "Immunization.vaccineCode",
        "path": "Immunization.vaccineCode",
        "mustSupport": true
      },
      {
        "id": "Immunization.vaccineCode.coding",
        "path": "Immunization.vaccineCode.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "$this"
            }
          ],
          "description": "Slice based on $this pattern",
          "rules": "open"
        },
        "min": 1,
        "max": "2"
      },
      {
        "id": "Immunization.vaccineCode.coding.system",
        "path": "Immunization.vaccineCode.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.code",
        "path": "Immunization.vaccineCode.coding.code",
        "definition": "BASE RESOURCE DEFINITION: \r\nA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).\r\n\r\nCDS-S PROFILE DEFINITION: \r\nThe immunogen component of the \"Vaccine Type\" as described in the ‘Canadian Immunization Guide’.",
        "min": 1,
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Immunization Type",
          "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/vaccinehistoricalnamecode|https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode"
        },
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.003",
            "comment": "Immunization Type"
          }
        ]
      },
      {
        "id": "Immunization.vaccineCode.coding.display",
        "path": "Immunization.vaccineCode.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding:Generic",
        "path": "Immunization.vaccineCode.coding",
        "sliceName": "Generic",
        "short": "Immunizing agent / generic name",
        "max": "1",
        "binding": {
          "strength": "required",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/generic"
        }
      },
      {
        "id": "Immunization.vaccineCode.coding:Tradename",
        "path": "Immunization.vaccineCode.coding",
        "sliceName": "Tradename",
        "short": "Trade name of immunizing agent",
        "definition": "BASE RESOURCE DEFINITION: \r\nA reference to a code defined by a terminology system.\r\n\r\nCDS-S PROFILE DEFINITION:\r\nThe actual Drug Identification Number (DIN) from the EMR's Drug Database for the selected vaccine and/or as typed in by the user. This is the DIN of the vaccine that was administered.",
        "max": "1",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Trade Name"
        },
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.002",
            "comment": "Trade Name"
          }
        ]
      },
      {
        "id": "Immunization.vaccineCode.text",
        "path": "Immunization.vaccineCode.text",
        "definition": "BASE RESOURCE DEFINITION: \r\nA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.\r\n\r\nCDS-S PROFILE DEFINITION: \r\nThe brand name under which the administered vaccine is marketed in Canada (provided by EMR's drug database) or the name of the vaccine as typed in by the provider.",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Immunization Name",
          "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/vaccineadministeredtradenamecode"
        },
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.001",
            "comment": "Immunization Name"
          }
        ]
      },
      {
        "id": "Immunization.patient",
        "path": "Immunization.patient",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://simplifier.net/omd-cdss/patientprofile"
            ]
          }
        ]
      },
      {
        "id": "Immunization.occurrence[x]",
        "path": "Immunization.occurrence[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "rules": "open"
        },
        "definition": "BASE RESOURCE DEFINITION: \r\nDate vaccine administered or was to be administered.\r\n\r\nCDS-S PROFILE DEFINITION (Immunization Date):\r\nThe date the immunization was administered to the patient.\r\n\r\nCDS-S PROFILE DEFINITION (Immunization Refused Date):\r\nThe date the immunization was refused.",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Immunization.occurrence[x]:occurrenceDateTime",
        "path": "Immunization.occurrence[x]",
        "sliceName": "occurrenceDateTime",
        "definition": "BASE RESOURCE DEFINITION: \r\nDate vaccine administered or was to be administered.\r\n\r\nCDS-S PROFILE DEFINITION (Immunization Date):\r\nThe date the immunization was administered to the patient.\r\n\r\nCDS-S PROFILE DEFINITION (Immunization Refused Date):\r\nThe date the immunization was refused.",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.009",
            "comment": "Immunization Date"
          },
          {
            "identity": "CDSS5.1",
            "map": "DE08.010",
            "comment": "Immunization Refused Date"
          }
        ]
      },
      {
        "id": "Immunization.primarySource",
        "path": "Immunization.primarySource",
        "short": "An indication whether the content of the record originated from the primary source",
        "min": 1
      },
      {
        "id": "Immunization.reportOrigin",
        "path": "Immunization.reportOrigin",
        "short": "The source of the data when the report of the immunization event is not based on information from the primary source",
        "binding": {
          "strength": "required",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/repsource"
        }
      },
      {
        "id": "Immunization.reportOrigin.coding",
        "path": "Immunization.reportOrigin.coding",
        "min": 1,
        "max": "1"
      },
      {
        "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.location",
        "path": "Immunization.location",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://simplifier.net/omd-cdss/locationprofile"
            ]
          }
        ]
      },
      {
        "id": "Immunization.location.display",
        "path": "Immunization.location.display",
        "short": "Service Delivery Location where the immunization was administered",
        "min": 1
      },
      {
        "id": "Immunization.manufacturer",
        "path": "Immunization.manufacturer",
        "definition": "BASE RESOURCE DEFINITION: \r\nName of vaccine manufacturer.\r\n\r\nCDS-S PROFILE DEFINITION:\r\nThe manufacturer of the administered immunization.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://simplifier.net/omd-cdss/organizationprofile"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.004",
            "comment": "Manufacturer"
          }
        ]
      },
      {
        "id": "Immunization.lotNumber",
        "path": "Immunization.lotNumber",
        "short": "Lot number",
        "definition": "BASE RESOURCE DEFINITION: \r\nLot number of the  vaccine product.\r\n\r\nCDS-S PROFILE DEFINITION: \r\nThe product lot number corresponding to the administered immunization.",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.005",
            "comment": "Lot #"
          }
        ]
      },
      {
        "id": "Immunization.expirationDate",
        "path": "Immunization.expirationDate",
        "short": "Lot expiration date"
      },
      {
        "id": "Immunization.site",
        "path": "Immunization.site",
        "binding": {
          "strength": "extensible",
          "valueSet": "https://www.hl7.org/fhir/valueset-immunization-site.html"
        }
      },
      {
        "id": "Immunization.site.coding",
        "path": "Immunization.site.coding",
        "min": 1,
        "max": "1"
      },
      {
        "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",
        "definition": "BASE RESOURCE DEFINITION:\r\nA representation of the meaning of the code in the system, following the rules of the system.\r\n\r\nCDS-S PROFILE DEFINITION:\r\nThe anatomical site location of the administered immunization.",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.007",
            "comment": "Site"
          }
        ]
      },
      {
        "id": "Immunization.route",
        "path": "Immunization.route",
        "binding": {
          "strength": "extensible",
          "valueSet": "https://www.hl7.org/fhir/valueset-immunization-route.html"
        }
      },
      {
        "id": "Immunization.route.coding",
        "path": "Immunization.route.coding",
        "min": 1,
        "max": "1"
      },
      {
        "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",
        "definition": "BASE RESOURCE DEFINITION:\r\nA representation of the meaning of the code in the system, following the rules of the system.\r\n\r\nCDS-S PROFILE DEFINITION:\r\nThe route or method the immunization has been administered.",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.006",
            "comment": "Route"
          }
        ]
      },
      {
        "id": "Immunization.doseQuantity.value",
        "path": "Immunization.doseQuantity.value",
        "definition": "BASE RESOURCE DEFINITION:\r\nThe value of the measured amount. The value includes an implicit precision in the presentation of the value\r\n\r\nCDS-S PROFILE DEFINITION\r\nDose amount and unit of measure corresponding to the administered immunization.",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.008",
            "comment": "Dose"
          }
        ]
      },
      {
        "id": "Immunization.doseQuantity.unit",
        "path": "Immunization.doseQuantity.unit",
        "min": 1
      },
      {
        "id": "Immunization.performer.function",
        "path": "Immunization.performer.function",
        "min": 1,
        "fixedCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
              "code": "AP",
              "display": "Administering Provider"
            }
          ]
        }
      },
      {
        "id": "Immunization.performer.actor",
        "path": "Immunization.performer.actor",
        "short": "Individual who adminstered the immunization",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://simplifier.net/omd-cdss/practitionerprofile"
            ]
          }
        ]
      },
      {
        "id": "Immunization.note",
        "path": "Immunization.note",
        "short": "Additional immunization comments"
      },
      {
        "id": "Immunization.note.text",
        "path": "Immunization.note.text",
        "definition": "BASE RESOURCE DEFINITION:\r\nThe text of the annotation in markdown format.\r\n\r\nCDS-S PROFILE DEFINITION: \r\nAdditional information about the patient's immunization.",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.013",
            "comment": "Notes"
          }
        ]
      },
      {
        "id": "Immunization.isSubpotent",
        "path": "Immunization.isSubpotent",
        "short": "Dose potency flag"
      },
      {
        "id": "Immunization.protocolApplied",
        "path": "Immunization.protocolApplied",
        "short": "In the current release: populated only for the last immunization record",
        "definition": "BASE RESOURCE DEFINITION:\r\nThe protocol (set of recommendations) being followed by the provider who administered the dose.\r\n\r\nCDS-S PROFILE DEFINITION:\r\nInformation pertaining to how the vaccine should be administered (e.g., its relationship to other vaccinations in a series, instructions for the patient).",
        "mapping": [
          {
            "identity": "CDSS5.1",
            "map": "DE08.012",
            "comment": "Instructions"
          }
        ]
      },
      {
        "id": "Immunization.protocolApplied.targetDisease",
        "path": "Immunization.protocolApplied.targetDisease",
        "binding": {
          "strength": "required",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/disease"
        }
      },
      {
        "id": "Immunization.protocolApplied.doseNumber[x]",
        "path": "Immunization.protocolApplied.doseNumber[x]",
        "short": "doseNumberPostiveInt if a patient has at least 1 valide dose; doseNumberString='0' if a patient doesn't have any valid doses"
      },
      {
        "id": "Immunization.protocolApplied.seriesDoses[x]",
        "path": "Immunization.protocolApplied.seriesDoses[x]",
        "type": [
          {
            "code": "positiveInt"
          }
        ]
      }
    ]
  }
}