Package | ca.bc.bcy-ids |
Resource Type | StructureDefinition |
Id | ImmunizationRecommendation.StructureDefinition |
FHIR Version | R4 |
Source | https://simplifier.net/resolve?scope=ca.bc.bcy-ids@1.0.0&canonical=http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation |
URL | http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation |
Status | draft |
Name | ImmunizationRecommendation |
Type | ImmunizationRecommendation |
Kind | resource |
No resources found
No resources found
No narrative content found in resource
{ "resourceType": "StructureDefinition", "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation", "name": "ImmunizationRecommendation", "status": "draft", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "ImmunizationRecommendation", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", "derivation": "constraint", "differential": { "element": [ { "id": "ImmunizationRecommendation", "path": "ImmunizationRecommendation", "short": "FHIR resource applies for PIR Vaccine Forecast", "definition": "FHIR resource applies for PIR Vaccine Forecast" }, { "id": "ImmunizationRecommendation.id", "path": "ImmunizationRecommendation.id", "short": "PIR Internal Vaccination Forecast ID", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID" }, { "identity": "source-PHSL", "map": "forecastId" } ] }, { "id": "ImmunizationRecommendation.meta", "path": "ImmunizationRecommendation.meta", "min": 1 }, { "id": "ImmunizationRecommendation.meta.versionId", "path": "ImmunizationRecommendation.meta.versionId", "comment": "Apply \"2025.01.1\". This indicates the FHIR Specs as of year 2025 Jan." }, { "id": "ImmunizationRecommendation.meta.lastUpdated", "path": "ImmunizationRecommendation.meta.lastUpdated", "comment": "Updated: Relax the previously crossed-out elements." }, { "id": "ImmunizationRecommendation.meta.profile", "path": "ImmunizationRecommendation.meta.profile", "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation\"", "min": 1, "max": "1" }, { "id": "ImmunizationRecommendation.meta.security", "path": "ImmunizationRecommendation.meta.security", "max": "1" }, { "id": "ImmunizationRecommendation.meta.tag", "path": "ImmunizationRecommendation.meta.tag", "max": "1" }, { "id": "ImmunizationRecommendation.contained", "path": "ImmunizationRecommendation.contained", "max": "1" }, { "id": "ImmunizationRecommendation.identifier", "path": "ImmunizationRecommendation.identifier", "short": "PIR Internal Vaccination Forecast ID", "definition": "PIR Internal Vaccination Forecast ID", "min": 1, "max": "1" }, { "id": "ImmunizationRecommendation.identifier.type", "path": "ImmunizationRecommendation.identifier.type", "min": 1 }, { "id": "ImmunizationRecommendation.identifier.type.id", "path": "ImmunizationRecommendation.identifier.type.id", "max": "0" }, { "id": "ImmunizationRecommendation.identifier.type.coding", "path": "ImmunizationRecommendation.identifier.type.coding", "max": "0" }, { "id": "ImmunizationRecommendation.identifier.type.text", "path": "ImmunizationRecommendation.identifier.type.text", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "PANORAMAIMMZFORECASTID" } ] }, { "id": "ImmunizationRecommendation.identifier.system", "path": "ImmunizationRecommendation.identifier.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-forecaster-id" } ] }, { "id": "ImmunizationRecommendation.identifier.value", "path": "ImmunizationRecommendation.identifier.value", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID" }, { "identity": "source-PHSL", "map": "forecastId" } ] }, { "id": "ImmunizationRecommendation.patient.reference", "path": "ImmunizationRecommendation.patient.reference", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "fullURL of Panorama + \"Patient\" + PIR Client ID" } ] }, { "id": "ImmunizationRecommendation.date", "path": "ImmunizationRecommendation.date", "short": "Date Forecast Status Calculated as of", "definition": "Date Forecast Status Calculated as of", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "PIR H33_VACCINATION_FORECAST.CREATED_ON" } ] }, { "id": "ImmunizationRecommendation.authority", "path": "ImmunizationRecommendation.authority", "short": "Organization runs the vaccination forecast", "definition": "Organization runs the vaccination forecast", "comment": "For IDS, Panorama is the organization that runs the vaccination forecast.", "min": 1 }, { "id": "ImmunizationRecommendation.authority.reference", "path": "ImmunizationRecommendation.authority.reference", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "fullURL of Panorama + \"Organization\" + PIR Organization ID" } ] }, { "id": "ImmunizationRecommendation.recommendation", "path": "ImmunizationRecommendation.recommendation", "short": "Vaccine forecasted to be administered.", "definition": "Vaccine forecasted to be administered with different date criterion + targeted disease(s).", "comment": "1st instance is the Agent + Antigen(s) + Agent Dates + no Disease, subsequent instances are Antigen + Disease + Disease Dates" }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode", "path": "ImmunizationRecommendation.recommendation.vaccineCode", "min": 1 }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding", "slicing": { "discriminator": [ { "type": "value", "path": "code" } ], "rules": "open" }, "min": 1, "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system", "comment": "See Mappings" }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding", "sliceName": "AgentNVC", "short": "Agent in CVC code", "definition": "Agent in CVC code", "min": 1, "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.system", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "Code-SNOMED", "map": "http://snomed.info/sct" }, { "identity": "Code-NVC", "map": "https://nvc-cnv.canada.ca" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.code", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "PIR H33_VACCINATION_FORECAST.FAMILY_CODE" }, { "identity": "source-PHSL", "map": "forecastIImmsAgentCode" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.display", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "REPORTNG.GET_ITERM_DESC(H33_VACCINATION_FORECAST.FAMILY_CODE)" }, { "identity": "source-PHSL", "map": "forecastImmsAgentDescription" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding", "sliceName": "AgentPIR", "short": "Agent in PIR code", "definition": "Agent in PIR code", "comment": "Agent in PIR code. See Mappings.", "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.system", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system", "min": 1, "mapping": [ { "identity": "code-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.code", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code", "min": 1 }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.display", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display", "min": 1 }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding", "sliceName": "AntigenNVC", "short": "Antigen in NVC code", "definition": "Antigen in NVC code", "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.system", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "Code-SNOMED", "map": "http://snomed.info/sct" }, { "identity": "Code-NVC", "map": "https://nvc-cnv.canada.ca" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.code", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "FORECAST_ANTIGEN.ASIIS_VACC_CODE" }, { "identity": "source-PHSL", "map": "Antigen.forecastImmsAntigenCode" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.display", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "REPORTNG.GET_ITERM_DESC(FORECAST_ANTIGEN.ASIIS_VACC_CODE)" }, { "identity": "source-PHSL", "map": "Antigen.forecastImmsAntigenDescription" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding", "sliceName": "AntigenPIR", "short": "Antigen in PIR code", "definition": "Antigen in PIR code", "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.system", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system", "comment": "Anitgen in PIR code. See Mappings", "min": 1, "mapping": [ { "identity": "code-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" } ] }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.code", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code", "min": 1 }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.display", "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display", "min": 1 }, { "id": "ImmunizationRecommendation.recommendation.vaccineCode.text", "path": "ImmunizationRecommendation.recommendation.vaccineCode.text", "short": "Trade Name", "definition": "Trade Name", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "H33_VACCINATION_FORECAST.TRADE" }, { "identity": "source-PHSL", "map": "trade" } ] }, { "id": "ImmunizationRecommendation.recommendation.targetDisease.id", "path": "ImmunizationRecommendation.recommendation.targetDisease.id", "max": "0" }, { "id": "ImmunizationRecommendation.recommendation.targetDisease.coding", "path": "ImmunizationRecommendation.recommendation.targetDisease.coding", "short": "1st instance Disease in CVC code, 2nd instance Disease in PIR code", "definition": "1st instance Disease in CVC code, 2nd instance Disease in PIR code", "comment": "One Agent can have > 1 antigen, and one agent can have > 1 disease", "min": 1 }, { "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", "short": "1st instance: Disease in NVC code. 2nd instance: Disease in PIR code.", "definition": "1st instance: Disease in NVC code. 2nd instance: Disease in PIR code.", "comment": "1st instance: Disease in NVC code. 2nd instance: Disease in PIR code. See Mappings", "min": 1, "mapping": [ { "identity": "code-NVC", "map": "https://nvc-cnv.canada.ca" }, { "identity": "code-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-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", "comment": "1st instance Disease in CVC code, 2nd instance Disease in PIR code. See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR-disease", "map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(DISEASE.DISEASE_CODE_CNCPT_ID)" }, { "identity": "source-PHSL", "map": "Antigen.immunizationDiseaseCode" } ] }, { "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.display", "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.display", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "REPORTNG.GET_ITERM_DESC(DISEASE.DISEASE_CODE_CNCPT_ID)" }, { "identity": "source-PHSL", "map": "Antigen.immunizationDiseaseDescription" } ] }, { "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected", "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected", "max": "0" }, { "id": "ImmunizationRecommendation.recommendation.targetDisease.text", "path": "ImmunizationRecommendation.recommendation.targetDisease.text", "max": "0" }, { "id": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode", "path": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode", "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.forecastStatus", "path": "ImmunizationRecommendation.recommendation.forecastStatus", "short": "Vaccination forecast status" }, { "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding", "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding", "min": 1, "max": "1" }, { "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", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" } ] }, { "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", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR-calculated-overdue", "map": "OVERDUE" }, { "identity": "source-PIR-calculated-due", "map": "DUE" }, { "identity": "source-PIR-calculated-eligible", "map": "ELIGIBLE" }, { "identity": "source-PIR-calculated-upToDate", "map": "UPTODATE" }, { "identity": "source-PIR-calculated-notForecasted", "map": "NOTFORECASTED" }, { "identity": "source-PIR-calculated-unknown", "map": "UNKNOWN" }, { "identity": "source-PHSL", "map": "forecastStatus" } ] }, { "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.display", "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.display", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR-calculated-overdue", "map": "Overdue" }, { "identity": "source-PIR-calculated-due", "map": "Due" } ] }, { "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected", "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected", "max": "0" }, { "id": "ImmunizationRecommendation.recommendation.forecastReason", "path": "ImmunizationRecommendation.recommendation.forecastReason", "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion", "path": "ImmunizationRecommendation.recommendation.dateCriterion", "definition": "Vaccination date recommendations. For example, earliest date to administer, latest date to administer, etc.", "min": 1 }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.id", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.id", "max": "0" }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding", "min": 1, "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.id", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.id", "max": "0" }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "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", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR-eligible-date", "map": "30981-5" }, { "identity": "source-PIR-due-date", "map": "30980-7" }, { "identity": "source-PIR-past-due-date", "map": "59778-1" }, { "identity": "source-PIR-max-date", "map": "59777-3" }, { "identity": "source-PHSL-agent-eligible-date", "map": "agentEligibleDate" }, { "identity": "source-PHSL-agent-due-date", "map": "agentDueDate" }, { "identity": "source-PHSL-agent-past-due-date", "map": "agentPastDueDate" }, { "identity": "source-PHSL-agent-max-date", "map": "agentMaxDate" }, { "identity": "source-PHSL-antigen.disease-eligible-date", "map": "Antigen.diseaseEligibleDate" }, { "identity": "source-PHSL-antigen-disease-due-date", "map": "Antigen.diseaseDueDate" } ] }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR-eligible-date", "map": "Earliest date to give" }, { "identity": "source-PIR-due-date", "map": "Date vaccine due" }, { "identity": "source-PIR-past-due-date", "map": "Date when overdue for immunization" }, { "identity": "source-PIR-max-date", "map": "Latest date to give immunization" } ] }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected", "max": "0" }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.text", "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.text", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR-agent-eligible-date", "map": "Forecast by Agent Eligible Date" }, { "identity": "source-PIR-agent-due-date", "map": "Forecast by Agent Due Date" }, { "identity": "source-PIR-agent-past-due-date", "map": "Forecast by Agent Past Due Date" }, { "identity": "source-PIR-agent-max-date", "map": "Forecast by Agent Max Date" }, { "identity": "source-PIR-disease-eligible-date", "map": "Forecast by Disease Eligible Date" }, { "identity": "source-PIR-disease-due-date", "map": "Forecast by Disease Due Date" } ] }, { "id": "ImmunizationRecommendation.recommendation.dateCriterion.value", "path": "ImmunizationRecommendation.recommendation.dateCriterion.value", "comment": "See Mappings", "mapping": [ { "identity": "Date-PastDue", "map": "PAST_DUE_DATE in REPORTNG.H33_VACCINATION_FORECAST" }, { "identity": "Date-MaxDate", "map": "MAXIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST" }, { "identity": "Date-Eligible", "map": "MINIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST" }, { "identity": "Date-Due", "map": "DUE_DATE in REPORTNG.H33_VACCINATION_FORECAST" }, { "identity": "Date-DiseaseEligibleDate", "map": "H33_VACCINATION_FORECAST.MINIMUM_DATE" }, { "identity": "Date-DiseaseDueDate", "map": "H33_VACCINATION_FORECAST.DUE_DATE" } ] }, { "id": "ImmunizationRecommendation.recommendation.description", "path": "ImmunizationRecommendation.recommendation.description", "short": "Forecast Agent + Antigen combined description", "definition": "Forecast Agent + Antigen combined description", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "BCYREPORTNG.RBCY_T_AGENT_ANTIGENS_COMBINED.ANTIGENS" }, { "identity": "source-PHSL", "map": "Antigen.forecastAgentAntigenCombinedDescription" } ] }, { "id": "ImmunizationRecommendation.recommendation.doseNumber[x]", "path": "ImmunizationRecommendation.recommendation.doseNumber[x]", "comment": "See Mappings", "type": [ { "code": "string" } ], "mapping": [ { "identity": "source-PIR", "map": "PIR h33_vaccination_forecast.Dose_Number" } ] }, { "id": "ImmunizationRecommendation.recommendation.supportingImmunization", "path": "ImmunizationRecommendation.recommendation.supportingImmunization", "max": "1" }, { "id": "ImmunizationRecommendation.recommendation.supportingPatientInformation", "path": "ImmunizationRecommendation.recommendation.supportingPatientInformation", "max": "1" } ] } }