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