{
  "resourceType": "StructureDefinition",
  "id": "20f636ba-3696-4c28-8a2c-e624bfebbb2b",
  "meta": {
    "lastUpdated": "2020-08-04T20:24:48.452+00:00"
  },
  "url": "http://ehealthbc.ca/fhir/StructureDefinition/ImmunizationRecommendation",
  "name": "ImmunizationRecommendation",
  "status": "draft",
  "date": "2020-08-04T20:24:47.2955149+00:00",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "ImmunizationRecommendation",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "ImmunizationRecommendation.id",
        "path": "ImmunizationRecommendation.id",
        "definition": "Agent Level: clientId_immunizationHistoryId_agentCode ;  \r\nAntigen Level: clientId_immunizationHistoryId_agentCode_antigenCode",
        "comment": "Agent Level: clientId_immunizationHistoryId_agentCode ;  \r\nAntigen Level: clientId_immunizationHistoryId_agentCode_antigenCode"
      },
      {
        "id": "ImmunizationRecommendation.meta",
        "path": "ImmunizationRecommendation.meta",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.implicitRules",
        "path": "ImmunizationRecommendation.implicitRules",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.language",
        "path": "ImmunizationRecommendation.language",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.text",
        "path": "ImmunizationRecommendation.text",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.contained",
        "path": "ImmunizationRecommendation.contained",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.identifier",
        "path": "ImmunizationRecommendation.identifier",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ImmunizationRecommendation.identifier.id",
        "path": "ImmunizationRecommendation.identifier.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.identifier.use",
        "path": "ImmunizationRecommendation.identifier.use",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.identifier.type",
        "path": "ImmunizationRecommendation.identifier.type",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.identifier.system",
        "path": "ImmunizationRecommendation.identifier.system",
        "short": "Vaccination Forecast Identifier",
        "definition": "Vaccination Forecast Identifier",
        "fixedUri": "https://ehealthbc.ca/NamingSystem/ca-bc-panorama-immunization-forecast-id"
      },
      {
        "id": "ImmunizationRecommendation.identifier.value",
        "path": "ImmunizationRecommendation.identifier.value",
        "short": "H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID",
        "definition": "H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID",
        "comment": "JSON Attribute: forecastId",
        "min": 1
      },
      {
        "id": "ImmunizationRecommendation.identifier.period",
        "path": "ImmunizationRecommendation.identifier.period",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.identifier.assigner",
        "path": "ImmunizationRecommendation.identifier.assigner",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.patient.type",
        "path": "ImmunizationRecommendation.patient.type",
        "fixedUri": "Patient"
      },
      {
        "id": "ImmunizationRecommendation.patient.identifier",
        "path": "ImmunizationRecommendation.patient.identifier",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.patient.display",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.patient.display",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.date",
        "path": "ImmunizationRecommendation.date",
        "short": "H33_VACCINATION_FORECAST.CREATED_ON",
        "definition": "H33_VACCINATION_FORECAST.CREATED_ON",
        "comment": "JSON Attribute: forecastCreationDate (yyyy-mm-dd)"
      },
      {
        "id": "ImmunizationRecommendation.authority",
        "path": "ImmunizationRecommendation.authority",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.id",
        "path": "ImmunizationRecommendation.recommendation.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode",
        "path": "ImmunizationRecommendation.recommendation.vaccineCode",
        "comment": "Two Levels:  Agent and Antigen, indicates by the system value",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.id",
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.id",
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
        "definition": "Agent Level: https://ehealth.bc.ca/NamingSystem/ca-bc-panorama-immunization-agent-code\r\nAntigen Level: https://ehealth.bc.ca/NamingSystem/ca-bc-panorama-immunization-antigen-code"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.version",
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.version",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code",
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code",
        "short": "Agent / Antigen code",
        "definition": "Agent level: H33_VACCINATION_FORECAST.FAMILY_CODE\r\nAntigen Level: ASIIS_VACC_CODE",
        "comment": "Agent Level: JSON Attribute: forecastImmsAgentCode; \r\nAntigen Level: JSON Attribute: forecastImmsAntigenDescription",
        "min": 1
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display",
        "short": "Forecast Immunization Agent / Antigen Description",
        "definition": "Agent Level: H33_VACCINATION_FORECAST.FAMILY_CODE\r\nAntigen Lavel: VACC_DESCP",
        "comment": "Agent Level: JSON Attribute: forecastImmsAgentDescription;\r\nAntigen Level: JSON Attribute: forecastImmsAntigenDescription",
        "min": 1
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.userSelected",
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.userSelected",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.vaccineCode.text",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.vaccineCode.text",
        "comment": "Antigen Level: JSON Attribute: forecastAgentAntigenCombinedDescription"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.id",
        "path": "ImmunizationRecommendation.recommendation.targetDisease.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.id",
        "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.system",
        "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.system",
        "fixedUri": "https://ehealth.bc.ca/NamingSystem/ca-bc-panorama-immunization-disease-code"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.version",
        "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.version",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.code",
        "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.code",
        "short": "Forecast Immunization Disease Code",
        "definition": "Forecast Immunization Disease Code",
        "comment": "JSON Attribute: immunizationDiseaseCode"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.display",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.display",
        "short": "Forecast Immunization Disease Description",
        "definition": "Forecast Immunization Disease Description",
        "comment": "JSON Attribute: immunizationDiseaseDescription"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected",
        "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.targetDisease.text",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.targetDisease.text",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
        "path": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus",
        "path": "ImmunizationRecommendation.recommendation.forecastStatus",
        "comment": "CGI to add forecastStatus to REST Service; FHIR conformant: Possible value: due / overdue / immue / contraindicated / complete"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.id",
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.id",
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.system",
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.system",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.version",
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.version",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.code",
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.code",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.display",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.display",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected",
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastStatus.text",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.forecastStatus.text",
        "short": "Forecast Status",
        "definition": "FHIR conformant: Possible value: due / overdue / immue / contraindicated / complete",
        "comment": "JSON attribute:  forecastStatus",
        "min": 1
      },
      {
        "id": "ImmunizationRecommendation.recommendation.forecastReason",
        "path": "ImmunizationRecommendation.recommendation.forecastReason",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.id",
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.id",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding",
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding",
        "max": "1"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system",
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system",
        "max": "0",
        "fixedUri": "http://loinc.org"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.version",
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.version",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.code",
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.code",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected",
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.text",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.text",
        "short": "Forecast Eligible Date / Due Date by Agent or Disease",
        "definition": "Forecast by Agent Eligible Date / Forecast by Agent Due Date  or Forecast by Disease Eligible Date / Forecast by Disease Due Date",
        "comment": "Forecast by Agent Eligible Date / Forecast by Agent Due Date  or Forecast by Disease Eligible Date / Forecast by Disease Due Date"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.dateCriterion.value",
        "path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
        "short": "Forecast By Agent/Antigen/Disease Dates",
        "definition": "VALUE:  Forecast Eligible Date by agent / Forecast Due Date by Agent or Forecast by Disease Eligible Date / Forecast by Disease Due Date",
        "comment": "JSON Attribute:  agentEligibleDate / agentDueDate; diseaseEligibleDate / diseaseDueDate"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.description",
        "path": "ImmunizationRecommendation.recommendation.description",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.series",
        "path": "ImmunizationRecommendation.recommendation.series",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.doseNumber[x]",
        "path": "ImmunizationRecommendation.recommendation.doseNumber[x]",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.seriesDoses[x]",
        "path": "ImmunizationRecommendation.recommendation.seriesDoses[x]",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.supportingImmunization",
        "path": "ImmunizationRecommendation.recommendation.supportingImmunization",
        "max": "0"
      },
      {
        "id": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
        "path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
        "max": "0"
      }
    ]
  }
}