### ----------------------------------------------------
### -- FHIR
### -- Licenses: Artistic-2.0
### -- Authors: Hugh Simpson
### -- File: t/resources/structureDefinition/Immunization.json
### ----------------------------------------------------
### -- Chunk 12 of 12
 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.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "boolean"
      }],
      "meaningWhenMissing" : "By default, a dose should be considered to be potent.",
      "isModifier" : true,
      "isModifierReason" : "This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.",
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "RXA-20 = PA (partial administration)"
      },
      {
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.subpotentReason",
      "path" : "Immunization.subpotentReason",
      "short" : "Reason for being subpotent",
      "definition" : "Reason why a dose is considered to be subpotent.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "SubpotentReason"
        }],
        "strength" : "example",
        "description" : "The reason why a dose is considered to be subpotent.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-subpotent-reason"
      },
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.education",
      "path" : "Immunization.education",
      "short" : "Educational material presented to patient",
      "definition" : "Educational material presented to the patient (or guardian) at the time of vaccine administration.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "BackboneElement"
      }],
      "constraint" : [{
        "key" : "imm-1",
        "severity" : "error",
        "human" : "One of documentType or reference SHALL be present",
        "expression" : "documentType.exists() or reference.exists()",
        "xpath" : "exists(f:documentType) or exists(f:reference)"
      }],
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.education.documentType",
      "path" : "Immunization.education.documentType",
      "short" : "Educational material document identifier",
      "definition" : "Identifier of the material presented to the patient.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "OBX-5 : OBX-3 = 69764-9"
      },
      {
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.education.reference",
      "path" : "Immunization.education.reference",
      "short" : "Educational material reference pointer",
      "definition" : "Reference pointer to the educational material given to the patient if the information was on line.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "uri"
      }],
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.education.publicationDate",
      "path" : "Immunization.education.publicationDate",
      "short" : "Educational material publication date",
      "definition" : "Date the educational material was published.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "dateTime"
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "OBX-5 : OBX-3 = 29768-9"
      },
      {
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.education.presentationDate",
      "path" : "Immunization.education.presentationDate",
      "short" : "Educational material presentation date",
      "definition" : "Date the educational material was given to the patient.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "dateTime"
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "OBX-5 : OBX-3 = 29769-7"
      },
      {
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.programEligibility",
      "path" : "Immunization.programEligibility",
      "short" : "Patient eligibility for a vaccination program",
      "definition" : "Indicates a patient's eligibility for a funding program.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "ProgramEligibility"
        }],
        "strength" : "example",
        "description" : "The patient's eligibility for a vaccation program.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-program-eligibility"
      },
      "mapping" : [{
        "identity" : "v2",
        "map" : "OBX-5 : OBX-3 = 64994-7"
      },
      {
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.fundingSource",
      "path" : "Immunization.fundingSource",
      "short" : "Funding source for the vaccine",
      "definition" : "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "FundingSource"
        }],
        "strength" : "example",
        "description" : "The source of funding used to purchase the vaccine administered.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-funding-source"
      },
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.reaction",
      "path" : "Immunization.reaction",
      "short" : "Details of a reaction that follows immunization",
      "definition" : "Categorical data indicating that an adverse event is associated in time to an immunization.",
      "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.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "BackboneElement"
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "OBX-3"
      },
      {
        "identity" : "rim",
        "map" : "Observation[classCode=obs].code"
      }]
    },
    {
      "id" : "Immunization.reaction.date",
      "path" : "Immunization.reaction.date",
      "short" : "When reaction started",
      "definition" : "Date of reaction to the immunization.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "dateTime"
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)"
      },
      {
        "identity" : "rim",
        "map" : ".effectiveTime"
      }]
    },
    {
      "id" : "Immunization.reaction.detail",
      "path" : "Immunization.reaction.detail",
      "short" : "Additional information on reaction",
      "definition" : "Details of the reaction.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation"]
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "OBX-5"
      },
      {
        "identity" : "rim",
        "map" : ".value"
      }]
    },
    {
      "id" : "Immunization.reaction.reported",
      "path" : "Immunization.reaction.reported",
      "short" : "Indicates self-reported reaction",
      "definition" : "Self-reported indicator.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "boolean"
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "(HL7 v2 doesn't seem to provide for this)"
      },
      {
        "identity" : "rim",
        "map" : ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
      }]
    },
    {
      "id" : "Immunization.protocolApplied",
      "path" : "Immunization.protocolApplied",
      "short" : "Protocol followed by the provider",
      "definition" : "The protocol (set of recommendations) being followed by the provider who administered the dose.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "BackboneElement"
      }],
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.protocolApplied.series",
      "path" : "Immunization.protocolApplied.series",
      "short" : "Name of vaccine series",
      "definition" : "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.protocolApplied.authority",
      "path" : "Immunization.protocolApplied.authority",
      "short" : "Who is responsible for publishing the recommendations",
      "definition" : "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
      }],
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.protocolApplied.targetDisease",
      "path" : "Immunization.protocolApplied.targetDisease",
      "short" : "Vaccine preventatable disease being targetted",
      "definition" : "The vaccine preventable disease the dose is being administered against.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "TargetDisease"
        }],
        "strength" : "example",
        "description" : "The vaccine preventable disease the dose is being administered for.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-target-disease"
      },
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.protocolApplied.doseNumber[x]",
      "path" : "Immunization.protocolApplied.doseNumber[x]",
      "short" : "Dose number within series",
      "definition" : "Nominal position in a series.",
      "comment" : "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "positiveInt"
      },
      {
        "code" : "string"
      }],
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Immunization.protocolApplied.seriesDoses[x]",
      "path" : "Immunization.protocolApplied.seriesDoses[x]",
      "short" : "Recommended number of doses for immunity",
      "definition" : "The recommended number of doses to achieve immunity.",
      "comment" : "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "positiveInt"
      },
      {
        "code" : "string"
      }],
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    }]
  }
}


