{
  "resourceType": "StructureDefinition",
  "id": "ImmunizationEvaluation",
  "meta": {
    "lastUpdated": "2021-01-01T21:58:31.578+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Clinical.Medications"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "patient"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pher"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
      "valueCode": ".status = entered-in-error"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation",
  "version": "4.6.0",
  "name": "ImmunizationEvaluation",
  "status": "draft",
  "date": "2021-01-01T21:58:31+00:00",
  "publisher": "Health Level Seven International (Public Health and Emergency Response)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pher/index.cfm"
        }
      ]
    }
  ],
  "description": "Describes a comparison of an immunization event against published recommendations to determine if the administration is \"valid\" in relation to those  recommendations.",
  "fhirVersion": "4.6.0",
  "mapping": [
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "ImmunizationEvaluation",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
  "derivation": "specialization",
  "differential": {
    "element": [
      {
        "id": "ImmunizationEvaluation",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
            "valueString": "#8406."
          }
        ],
        "path": "ImmunizationEvaluation",
        "short": "Immunization evaluation information",
        "definition": "Describes a comparison of an immunization event against published recommendations to determine if the administration is \"valid\" in relation to those  recommendations.",
        "min": 0,
        "max": "*",
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event"
          },
          {
            "identity": "v2",
            "map": "RSP_K11"
          },
          {
            "identity": "w5",
            "map": "clinical.medication"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.identifier",
        "path": "ImmunizationEvaluation.identifier",
        "short": "Business identifier",
        "definition": "A unique identifier assigned to this immunization evaluation record.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.identifier"
          },
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.status",
        "path": "ImmunizationEvaluation.status",
        "short": "completed | entered-in-error",
        "definition": "Indicates the current status of the evaluation of the vaccination administration event.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid).",
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "ImmunizationEvaluationStatus"
            }
          ],
          "strength": "required",
          "description": "The status of the evaluation being done.",
          "valueSet": "http://hl7.org/fhir/ValueSet/immunization-evaluation-status"
        },
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.status"
          },
          {
            "identity": "w5",
            "map": "FiveWs.status"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.patient",
        "path": "ImmunizationEvaluation.patient",
        "short": "Who this evaluation is for",
        "definition": "The individual for whom the evaluation is being done.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient"
            ]
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.subject"
          },
          {
            "identity": "w5",
            "map": "FiveWs.subject[x]"
          },
          {
            "identity": "v2",
            "map": "PID-3"
          },
          {
            "identity": "w5",
            "map": "FiveWs.subject"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.date",
        "path": "ImmunizationEvaluation.date",
        "short": "Date evaluation was performed",
        "definition": "The date the evaluation of the vaccine administration event was performed.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.occurrenceDateTime"
          },
          {
            "identity": "w5",
            "map": "FiveWs.init"
          },
          {
            "identity": "v2",
            "map": "RXA-3"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.authority",
        "path": "ImmunizationEvaluation.authority",
        "short": "Who is responsible for publishing the recommendations",
        "definition": "Indicates the authority who published the protocol (e.g. ACIP).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "OBX-5 : OBX-3 = ( 59779-9 )"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.targetDisease",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
            "valueString": "#14371."
          }
        ],
        "path": "ImmunizationEvaluation.targetDisease",
        "short": "The vaccine preventable disease schedule being evaluated",
        "definition": "The vaccine preventable disease the dose is being evaluated against.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EvaluationTargetDisease"
            }
          ],
          "strength": "example",
          "description": "The vaccine preventable disease the dose is being evaluated against.",
          "valueSet": "http://hl7.org/fhir/ValueSet/immunization-target-disease"
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.immunizationEvent",
        "path": "ImmunizationEvaluation.immunizationEvent",
        "short": "Immunization being evaluated",
        "definition": "The vaccine administration event being evaluated.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Immunization"
            ]
          }
        ],
        "isSummary": true
      },
      {
        "id": "ImmunizationEvaluation.doseStatus",
        "path": "ImmunizationEvaluation.doseStatus",
        "short": "Status of the dose relative to published recommendations",
        "definition": "Indicates if the dose is valid or not valid with respect to the published recommendations.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EvaluationDoseStatus"
            }
          ],
          "strength": "example",
          "description": "The status of the administered dose relative to the published recommendations for the target disease.",
          "valueSet": "http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status"
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "OBX-5 : OBX-3 = ( 59781-5 )"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.doseStatusReason",
        "path": "ImmunizationEvaluation.doseStatusReason",
        "short": "Reason why the doese is considered valid, invalid or some other status",
        "definition": "Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EvaluationDoseStatusReason"
            }
          ],
          "strength": "example",
          "description": "The reason the dose status was assigned.",
          "valueSet": "http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status-reason"
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "OBX-5 : OBX-3 = ( 30982-3 )"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.description",
        "path": "ImmunizationEvaluation.description",
        "short": "Evaluation notes",
        "definition": "Additional information about the evaluation.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.note"
          },
          {
            "identity": "v2",
            "map": "OBX-5 : OBX-3 = ( 48767-8 )"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.series",
        "path": "ImmunizationEvaluation.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"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.doseNumber",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
            "valueString": "#13185 (add option for string), #25277 (restrict to string data type)."
          }
        ],
        "path": "ImmunizationEvaluation.doseNumber",
        "short": "Dose number within series",
        "definition": "Nominal position in a series as determined by the outcome of the evaluation process.",
        "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": "string"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "OBX-5 : OBX-3 = ( 30973-2 )"
          }
        ]
      },
      {
        "id": "ImmunizationEvaluation.seriesDoses",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
            "valueString": "#13185 (add option for string), #25277 (restrict to string data type)."
          }
        ],
        "path": "ImmunizationEvaluation.seriesDoses",
        "short": "Recommended number of doses for immunity",
        "definition": "The recommended number of doses to achieve immunity as determined by the outcome of the evaluation process.",
        "comment": "The use of an integer is preferred if known.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "OBX-5 : OBX-3 = ( 59782-3 )"
          }
        ]
      }
    ]
  }
}