{ "resourceType": "StructureDefinition", "id": "93f5e1a3-2acc-4ed1-9aa5-60590d503c3c", "meta": { "versionId": "3", "lastUpdated": "2022-05-17T22:12:22.3510675+00:00" }, "url": "http://ehealth.bc.ca/fhir/StructureDefinition/Immunization", "name": "Immunization", "status": "draft", "date": "2022-03-15T21:29:28.1739946+00:00", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "differential": { "element": [ { "id": "Immunization.id", "path": "Immunization.id", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-HA", "map": "EXTERNAL_IMMS_ID" }, { "identity": "source-eForm", "map": "\"e\"+(HA)+(EXTERNAL_IMMS_ID)" }, { "identity": "source-CznSub", "map": "(EXTERNAL_IMMS_ID)" }, { "identity": "source-PNet", "map": "(EXTERNAL_IMMS_ID)" } ] }, { "id": "Immunization.meta", "path": "Immunization.meta" }, { "id": "Immunization.meta.versionId", "path": "Immunization.meta.versionId", "fixedId": "2022.01" }, { "id": "Immunization.meta.profile", "path": "Immunization.meta.profile", "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/Immunization\"", "min": 1, "max": "1" }, { "id": "Immunization.implicitRules", "path": "Immunization.implicitRules", "max": "0" }, { "id": "Immunization.language", "path": "Immunization.language", "max": "0" }, { "id": "Immunization.text", "path": "Immunization.text", "max": "0" }, { "id": "Immunization.contained", "path": "Immunization.contained", "max": "0" }, { "id": "Immunization.identifier", "path": "Immunization.identifier", "min": 1, "max": "1" }, { "id": "Immunization.identifier.id", "path": "Immunization.identifier.id", "max": "0" }, { "id": "Immunization.identifier.use", "path": "Immunization.identifier.use", "max": "0" }, { "id": "Immunization.identifier.type.text", "path": "Immunization.identifier.type.text", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-eForm", "map": "\"EFORMIMMSID\"" }, { "identity": "source-CznSub", "map": "\"CZNSUBIMMSID\"" }, { "identity": "source-PNet", "map": "\"PHARMANETIMMS\"" }, { "identity": "source-fha", "map": "\"FHAPARISIMMS\"" }, { "identity": "source-nha", "map": "\"NHACEDARIMMS\"" }, { "identity": "source-vcha", "map": "\"VCHPARISIMMS\"" } ] }, { "id": "Immunization.identifier.system", "path": "Immunization.identifier.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-CznSub", "map": "\"https://ehealth.bc.ca/NamingSystem/ca-bc-citizen-submission\"" }, { "identity": "source-eForm", "map": "\"https://ehealth.bc.ca/NamingSystem/ca-bc-eForm\"" }, { "identity": "source-fha", "map": "\"https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha\"" }, { "identity": "source-nha", "map": "\"https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha\"" }, { "identity": "source-vcha", "map": "\"https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha\"" }, { "identity": "source-PNet", "map": "\"https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-pharmanet-document-number\"" } ] }, { "id": "Immunization.identifier.value", "path": "Immunization.identifier.value", "min": 1 }, { "id": "Immunization.identifier.period", "path": "Immunization.identifier.period", "max": "0" }, { "id": "Immunization.identifier.assigner", "path": "Immunization.identifier.assigner", "max": "0" }, { "id": "Immunization.status", "path": "Immunization.status", "comment": "Apply \"completed | entered-in-error\"" }, { "id": "Immunization.statusReason", "path": "Immunization.statusReason", "max": "0" }, { "id": "Immunization.vaccineCode.id", "path": "Immunization.vaccineCode.id", "max": "0" }, { "id": "Immunization.vaccineCode.coding.id", "path": "Immunization.vaccineCode.coding.id", "max": "0" }, { "id": "Immunization.vaccineCode.coding.system", "path": "Immunization.vaccineCode.coding.system", "comment": "Apply \"http://snomed.info/sct\"", "min": 1 }, { "id": "Immunization.vaccineCode.coding.version", "path": "Immunization.vaccineCode.coding.version", "max": "0" }, { "id": "Immunization.vaccineCode.coding.code", "path": "Immunization.vaccineCode.coding.code", "comment": "Agent/Tradename SNOMED code", "min": 1 }, { "id": "Immunization.vaccineCode.coding.display", "path": "Immunization.vaccineCode.coding.display", "min": 1 }, { "id": "Immunization.vaccineCode.coding.userSelected", "path": "Immunization.vaccineCode.coding.userSelected", "max": "0" }, { "id": "Immunization.vaccineCode.text", "path": "Immunization.vaccineCode.text", "max": "0" }, { "id": "Immunization.patient.id", "path": "Immunization.patient.id", "max": "0" }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-HA", "map": "\"Patient/Patient1\"" }, { "identity": "source-CznSub", "map": "fullURL + \"Patient/\" + (Patient ID)", "comment": "http://ehealth.bc.ca/cznSub/fhir/" }, { "identity": "source-eForm", "map": "fullURL + \"Patient/\" + (Patient ID)", "comment": "http://ehealth.bc.ca/eForm/fhir/" }, { "identity": "source-PNet", "map": "fullURL + \"Patient/\" + (Patient ID)", "comment": "http://ehealth.bc.ca/pharmaNet/fhir/" }, { "identity": "source-HA-2022", "map": "fullURL + \"Patient/\" + (Patient ID)" } ] }, { "id": "Immunization.patient.type", "path": "Immunization.patient.type", "max": "0" }, { "id": "Immunization.patient.identifier", "path": "Immunization.patient.identifier", "max": "0" }, { "id": "Immunization.patient.display", "path": "Immunization.patient.display", "max": "0" }, { "id": "Immunization.encounter", "path": "Immunization.encounter", "max": "0" }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "comment": "If Day is missing, use last day of estimated month. If year and/or month is missing, do not send imms record. Date format yyyy-mm-dd.", "type": [ { "code": "dateTime" } ] }, { "id": "Immunization.occurrence[x].id", "path": "Immunization.occurrence[x].id", "max": "0" }, { "id": "Immunization.recorded", "path": "Immunization.recorded", "max": "0" }, { "id": "Immunization.primarySource", "path": "Immunization.primarySource", "comment": "Apply \"false\"", "min": 1 }, { "id": "Immunization.reportOrigin", "path": "Immunization.reportOrigin", "min": 1 }, { "id": "Immunization.reportOrigin.id", "path": "Immunization.reportOrigin.id", "max": "0" }, { "id": "Immunization.reportOrigin.coding", "path": "Immunization.reportOrigin.coding", "min": 1, "max": "1" }, { "id": "Immunization.reportOrigin.coding.id", "path": "Immunization.reportOrigin.coding.id", "max": "0" }, { "id": "Immunization.reportOrigin.coding.system", "path": "Immunization.reportOrigin.coding.system", "comment": "Apply \"Personal Record\"", "min": 1 }, { "id": "Immunization.reportOrigin.coding.version", "path": "Immunization.reportOrigin.coding.version", "max": "0" }, { "id": "Immunization.reportOrigin.coding.code", "path": "Immunization.reportOrigin.coding.code", "comment": "Apply \"116154003\"", "min": 1 }, { "id": "Immunization.reportOrigin.coding.display", "path": "Immunization.reportOrigin.coding.display", "comment": "Apply \"Personal Record\"", "min": 1 }, { "id": "Immunization.reportOrigin.coding.userSelected", "path": "Immunization.reportOrigin.coding.userSelected", "max": "0" }, { "id": "Immunization.reportOrigin.text", "path": "Immunization.reportOrigin.text", "max": "0" }, { "id": "Immunization.location.id", "path": "Immunization.location.id", "max": "0" }, { "id": "Immunization.location.reference", "path": "Immunization.location.reference", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-eForm-sdl-dropdownlist", "map": "fullURL+\"Location/\"+(SDL_ID)+\"org\"+(BRANCH_ID)", "comment": "http://ehealth.bc.ca/eForm/fhir" }, { "identity": "source-cznSub-sdl-dropdownlist", "map": "fullURL+\"Location/\"+(SDL_ID)+\"org\"+(BRANCH_ID)", "comment": "http://ehealth.bc.ca/cznSub/fhir" }, { "identity": "source-cznSub-sdl-free-text", "map": "fullURL+\"Location/\"+(UNKn)+\"org3268\"", "comment": "n=1,2,3,4 etc; http://ehealth.bc.ca/cznSub/fhir" }, { "identity": "source-pharmaNet", "map": "fullURL+\"Location/\"+(PEM CODE)", "comment": "http://ehealth.bc.ca/pharmaNet/fhir" } ] }, { "id": "Immunization.location.type", "path": "Immunization.location.type", "max": "0" }, { "id": "Immunization.location.identifier", "path": "Immunization.location.identifier", "max": "0" }, { "id": "Immunization.location.display", "path": "Immunization.location.display", "max": "0" }, { "id": "Immunization.manufacturer", "path": "Immunization.manufacturer", "max": "0" }, { "id": "Immunization.site.id", "path": "Immunization.site.id", "max": "0" }, { "id": "Immunization.site.coding.id", "path": "Immunization.site.coding.id", "max": "0" }, { "id": "Immunization.site.coding.system", "path": "Immunization.site.coding.system", "comment": "Apply \"http://snomed.info/sct\"", "min": 1 }, { "id": "Immunization.site.coding.version", "path": "Immunization.site.coding.version", "max": "0" }, { "id": "Immunization.site.coding.code", "path": "Immunization.site.coding.code", "min": 1 }, { "id": "Immunization.site.coding.display", "path": "Immunization.site.coding.display", "min": 1 }, { "id": "Immunization.site.coding.userSelected", "path": "Immunization.site.coding.userSelected", "max": "0" }, { "id": "Immunization.route.id", "path": "Immunization.route.id", "max": "0" }, { "id": "Immunization.route.coding.id", "path": "Immunization.route.coding.id", "max": "0" }, { "id": "Immunization.route.coding.system", "path": "Immunization.route.coding.system", "comment": "Apply \"http://snomed.info/sct\"", "min": 1 }, { "id": "Immunization.route.coding.version", "path": "Immunization.route.coding.version", "max": "0" }, { "id": "Immunization.route.coding.code", "path": "Immunization.route.coding.code", "min": 1 }, { "id": "Immunization.route.coding.display", "path": "Immunization.route.coding.display", "min": 1 }, { "id": "Immunization.route.coding.userSelected", "path": "Immunization.route.coding.userSelected", "max": "0" }, { "id": "Immunization.route.text", "path": "Immunization.route.text", "max": "0" }, { "id": "Immunization.doseQuantity.id", "path": "Immunization.doseQuantity.id", "max": "0" }, { "id": "Immunization.doseQuantity.value", "path": "Immunization.doseQuantity.value", "min": 1 }, { "id": "Immunization.doseQuantity.unit", "path": "Immunization.doseQuantity.unit", "min": 1 }, { "id": "Immunization.doseQuantity.system", "path": "Immunization.doseQuantity.system", "max": "0" }, { "id": "Immunization.doseQuantity.code", "path": "Immunization.doseQuantity.code", "max": "0" }, { "id": "Immunization.performer", "path": "Immunization.performer", "min": 1, "max": "1" }, { "id": "Immunization.performer.id", "path": "Immunization.performer.id", "max": "0" }, { "id": "Immunization.performer.function", "path": "Immunization.performer.function", "min": 1 }, { "id": "Immunization.performer.function.id", "path": "Immunization.performer.function.id", "max": "0" }, { "id": "Immunization.performer.function.coding", "path": "Immunization.performer.function.coding", "min": 1, "max": "1" }, { "id": "Immunization.performer.function.coding.id", "path": "Immunization.performer.function.coding.id", "max": "0" }, { "id": "Immunization.performer.function.coding.system", "path": "Immunization.performer.function.coding.system", "comment": "Apply \"http://terminology.hl7.org/CodeSystem/v2-0443\"", "min": 1 }, { "id": "Immunization.performer.function.coding.version", "path": "Immunization.performer.function.coding.version", "max": "0" }, { "id": "Immunization.performer.function.coding.code", "path": "Immunization.performer.function.coding.code", "comment": "Apply \"AP\"", "min": 1 }, { "id": "Immunization.performer.function.coding.display", "path": "Immunization.performer.function.coding.display", "comment": "Apply \"Administering Provider\"", "min": 1 }, { "id": "Immunization.performer.function.coding.userSelected", "path": "Immunization.performer.function.coding.userSelected", "max": "0" }, { "id": "Immunization.performer.function.text", "path": "Immunization.performer.function.text", "max": "0" }, { "id": "Immunization.performer.actor.id", "path": "Immunization.performer.actor.id", "max": "0" }, { "id": "Immunization.performer.actor.reference", "path": "Immunization.performer.actor.reference", "comment": "See Mappings.", "min": 1, "mapping": [ { "identity": "source-eForm", "map": "fullURL + \"PractitionerPerformer\" + (Provider ID)", "comment": "http://ehealth.bc.ca/eForm/fhir/" }, { "identity": "source-HA", "map": "\"Practitioner/Performer1\"" }, { "identity": "source-PNet", "map": "fullURL + \"PractitionerPerformer\" + (Provider ID)", "comment": "http://ehealth.bc.ca/pharmaNet/fhir/" }, { "identity": "source-CznSub", "map": "\"Practitioner/Performer1\"" } ] }, { "id": "Immunization.performer.actor.type", "path": "Immunization.performer.actor.type", "max": "0" }, { "id": "Immunization.performer.actor.identifier", "path": "Immunization.performer.actor.identifier", "max": "0" }, { "id": "Immunization.performer.actor.display", "path": "Immunization.performer.actor.display", "max": "0" }, { "id": "Immunization.note.id", "path": "Immunization.note.id", "max": "0" }, { "id": "Immunization.note.author[x]", "path": "Immunization.note.author[x]", "max": "0" }, { "id": "Immunization.note.time", "path": "Immunization.note.time", "max": "0" }, { "id": "Immunization.reasonCode.id", "path": "Immunization.reasonCode.id", "max": "0" }, { "id": "Immunization.reasonCode.coding", "path": "Immunization.reasonCode.coding", "min": 1 }, { "id": "Immunization.reasonCode.coding.id", "path": "Immunization.reasonCode.coding.id", "max": "0" }, { "id": "Immunization.reasonCode.coding.system", "path": "Immunization.reasonCode.coding.system", "comment": "Apply \"https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-immunizations-reason\"", "min": 1 }, { "id": "Immunization.reasonCode.coding.version", "path": "Immunization.reasonCode.coding.version", "max": "0" }, { "id": "Immunization.reasonCode.coding.code", "path": "Immunization.reasonCode.coding.code", "min": 1 }, { "id": "Immunization.reasonCode.coding.display", "path": "Immunization.reasonCode.coding.display", "min": 1 }, { "id": "Immunization.reasonCode.coding.userSelected", "path": "Immunization.reasonCode.coding.userSelected", "max": "0" }, { "id": "Immunization.reasonCode.text", "path": "Immunization.reasonCode.text", "max": "0" }, { "id": "Immunization.reasonReference", "path": "Immunization.reasonReference", "max": "0" }, { "id": "Immunization.isSubpotent", "path": "Immunization.isSubpotent", "comment": "See Mappings", "mapping": [ { "identity": "dose-invalid", "map": "\"true\"" }, { "identity": "dose-override", "map": "\"true\"" }, { "identity": "dose-valid", "map": "\"false\"" } ] }, { "id": "Immunization.subpotentReason.id", "path": "Immunization.subpotentReason.id", "max": "0" }, { "id": "Immunization.subpotentReason.coding", "path": "Immunization.subpotentReason.coding", "slicing": { "discriminator": [ { "type": "value", "path": "code" } ], "rules": "open" } }, { "id": "Immunization.subpotentReason.coding.id", "path": "Immunization.subpotentReason.coding.id", "max": "0" }, { "id": "Immunization.subpotentReason.coding.system", "path": "Immunization.subpotentReason.coding.system", "max": "0" }, { "id": "Immunization.subpotentReason.coding.version", "path": "Immunization.subpotentReason.coding.version", "max": "0" }, { "id": "Immunization.subpotentReason.coding.code", "path": "Immunization.subpotentReason.coding.code", "max": "0" }, { "id": "Immunization.subpotentReason.coding.userSelected", "path": "Immunization.subpotentReason.coding.userSelected", "max": "0" }, { "id": "Immunization.subpotentReason.coding:doseStatusReason", "path": "Immunization.subpotentReason.coding", "sliceName": "doseStatusReason", "short": "Slice 1: Dose Status Reason", "comment": "To be applied when vaccine status = \"OI\", \"OV\"" }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.id", "path": "Immunization.subpotentReason.coding.id", "max": "0" }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.system", "path": "Immunization.subpotentReason.coding.system", "comment": "Apply \"https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-dose-status-reason\"", "min": 1 }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.version", "path": "Immunization.subpotentReason.coding.version", "max": "0" }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.userSelected", "path": "Immunization.subpotentReason.coding.userSelected", "max": "0" }, { "id": "Immunization.subpotentReason.coding:doseStatus", "path": "Immunization.subpotentReason.coding", "sliceName": "doseStatus", "min": 1, "max": "1" }, { "id": "Immunization.subpotentReason.coding:doseStatus.id", "path": "Immunization.subpotentReason.coding.id", "max": "0" }, { "id": "Immunization.subpotentReason.coding:doseStatus.system", "path": "Immunization.subpotentReason.coding.system", "comment": "Apply \"https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-dose-status\"", "min": 1 }, { "id": "Immunization.subpotentReason.coding:doseStatus.version", "path": "Immunization.subpotentReason.coding.version", "max": "0" }, { "id": "Immunization.subpotentReason.coding:doseStatus.code", "path": "Immunization.subpotentReason.coding.code", "min": 1 }, { "id": "Immunization.subpotentReason.coding:doseStatus.userSelected", "path": "Immunization.subpotentReason.coding.userSelected", "max": "0" }, { "id": "Immunization.education", "path": "Immunization.education", "max": "0" }, { "id": "Immunization.programEligibility", "path": "Immunization.programEligibility", "max": "0" }, { "id": "Immunization.fundingSource", "path": "Immunization.fundingSource", "max": "0" }, { "id": "Immunization.reaction", "path": "Immunization.reaction", "max": "0" }, { "id": "Immunization.protocolApplied.id", "path": "Immunization.protocolApplied.id", "max": "0" }, { "id": "Immunization.protocolApplied.series", "path": "Immunization.protocolApplied.series", "max": "0" }, { "id": "Immunization.protocolApplied.authority", "path": "Immunization.protocolApplied.authority", "max": "0" }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "max": "0" }, { "id": "Immunization.protocolApplied.doseNumber[x]", "path": "Immunization.protocolApplied.doseNumber[x]", "type": [ { "code": "string" } ] }, { "id": "Immunization.protocolApplied.seriesDoses[x]", "path": "Immunization.protocolApplied.seriesDoses[x]", "max": "0" } ] } }