{
"description": null,
"_filename": "CarePlan.StructureDefinition.json",
"package_name": "ca.bc.bcy-ids",
"date": "2022-03-04T22:33:55.2668635+00:00",
"derivation": "constraint",
"meta": {
"versionId": "7",
"lastUpdated": "2025-01-24T22:56:35.0626075+00:00"
},
"publisher": null,
"fhirVersion": "4.0.1",
"name": "CarePlan",
"abstract": false,
"type": "CarePlan",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"status": "draft",
"id": "49a463a8-1495-4f23-b644-62ac0f2c80ed",
"kind": "resource",
"url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan",
"version": null,
"differential": {
"element": [ {
"id": "CarePlan",
"path": "CarePlan",
"short": "FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution",
"comment": "resourceCarePlan contains resourceCondition for PIR Special Considerations data.",
"definition": "FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution"
}, {
"id": "CarePlan.id",
"min": 1,
"path": "CarePlan.id",
"short": "PIR internal Special Consideration ID",
"comment": "See Mappings",
"mapping": [ {
"map": "SPECIAL_CONSIDERATION.CONTRA_ID",
"identity": "source-PIR"
}, {
"map": "specialConsiderationId",
"identity": "source-PHSL"
} ],
"definition": "PIR internal Special Consideration Identifier"
}, {
"id": "CarePlan.meta",
"min": 1,
"path": "CarePlan.meta"
}, {
"id": "CarePlan.meta.versionId",
"path": "CarePlan.meta.versionId",
"comment": "Apply \"2025.01.1\". This indicates the FHIR Specs as of year 2025 Jan."
}, {
"id": "CarePlan.meta.lastUpdated",
"path": "CarePlan.meta.lastUpdated",
"comment": "Updated: Relax the previously crossed-out elements."
}, {
"id": "CarePlan.meta.profile",
"max": "1",
"min": 1,
"path": "CarePlan.meta.profile",
"comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan\""
}, {
"id": "CarePlan.meta.security",
"max": "1",
"path": "CarePlan.meta.security"
}, {
"id": "CarePlan.meta.tag",
"max": "1",
"path": "CarePlan.meta.tag"
}, {
"id": "CarePlan.contained",
"max": "1",
"min": 1,
"path": "CarePlan.contained",
"type": [ {
"code": "Resource",
"profile": [ "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Condition" ]
} ],
"short": "Contains resourceCondition as part of PIR Special Consideration",
"comment": "resourceCondition is part of PIR Special Consideration",
"definition": "Contains resourceCondition as part of PIR Special Consideration"
}, {
"id": "CarePlan.identifier",
"max": "1",
"min": 1,
"path": "CarePlan.identifier",
"short": "PIR internal Special Consideration Identifier + External Special Consideration ID from source system(s)",
"definition": "PIR internal Special Consideration Identifier + External Special Consideration ID from source system(s)"
}, {
"id": "CarePlan.identifier.type",
"min": 1,
"path": "CarePlan.identifier.type"
}, {
"id": "CarePlan.identifier.type.coding",
"max": "1",
"path": "CarePlan.identifier.type.coding"
}, {
"id": "CarePlan.identifier.type.text",
"min": 1,
"path": "CarePlan.identifier.type.text",
"comment": "See Mappings",
"mapping": [ {
"map": "\"PANORAMASCID\"",
"identity": "source-PIR"
} ]
}, {
"id": "CarePlan.identifier.system",
"min": 1,
"path": "CarePlan.identifier.system",
"mapping": [ {
"map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-special-consideration-id",
"identity": "source-PIR"
} ]
}, {
"id": "CarePlan.identifier.value",
"min": 1,
"path": "CarePlan.identifier.value",
"comment": "See Mappings",
"mapping": [ {
"map": "SPECIAL_CONSIDERATION.CONTRA_ID",
"identity": "source-PIR"
}, {
"map": "specialConsiderationId",
"identity": "source-PHSL"
} ]
}, {
"id": "CarePlan.instantiatesCanonical",
"max": "1",
"path": "CarePlan.instantiatesCanonical"
}, {
"id": "CarePlan.instantiatesUri",
"max": "1",
"path": "CarePlan.instantiatesUri"
}, {
"id": "CarePlan.basedOn",
"max": "1",
"path": "CarePlan.basedOn"
}, {
"id": "CarePlan.replaces",
"max": "1",
"path": "CarePlan.replaces"
}, {
"id": "CarePlan.partOf",
"max": "1",
"path": "CarePlan.partOf"
}, {
"id": "CarePlan.status",
"path": "CarePlan.status",
"short": "Possible status from PIR: | revoked | completed |",
"comment": "See Mappings",
"mapping": [ {
"map": "completed",
"identity": "source-PIR-active"
}, {
"map": "revoked",
"identity": "source-PIR-deleted"
} ],
"definition": "Possible status from PIR: | revoked | completed |. Revoked = deleted. Completed = active."
}, {
"id": "CarePlan.status.extension:_status",
"max": "1",
"path": "CarePlan.status.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status" ]
} ],
"comment": "To be applied when Special Consideration is deleted in PIR.",
"sliceName": "_status",
"isModifier": false
}, {
"id": "CarePlan.status.extension:_status.extension:scDeleteReason",
"path": "CarePlan.status.extension.extension",
"comment": "To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list or NO delete reason provided.",
"mapping": [ {
"map": "Other",
"identity": "source-PIR-nullReason"
} ],
"sliceName": "scDeleteReason"
}, {
"id": "CarePlan.status.extension:_status.extension:scDeleteReasonOther",
"path": "CarePlan.status.extension.extension",
"comment": "To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list. See Mappings.",
"mapping": [ {
"map": "unknown",
"identity": "source-PIR-null"
} ],
"sliceName": "scDeleteReasonOther"
}, {
"id": "CarePlan.intent",
"path": "CarePlan.intent",
"short": "PIR applies value | order | for FHIR purposes only.",
"comment": "Apply \"order\"",
"definition": "PIR applies value | order | for FHIR purposes only."
}, {
"id": "CarePlan.category",
"max": "1",
"path": "CarePlan.category"
}, {
"id": "CarePlan.subject.reference",
"min": 1,
"path": "CarePlan.subject.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "fullURL + \"Patient/\" + (Patient ID)",
"identity": "source-PIR"
} ]
}, {
"id": "CarePlan.period",
"min": 1,
"path": "CarePlan.period"
}, {
"id": "CarePlan.period.id",
"max": "0",
"path": "CarePlan.period.id"
}, {
"id": "CarePlan.period.start",
"min": 1,
"path": "CarePlan.period.start",
"comment": "See Mappings",
"mapping": [ {
"map": "SPECIAL_CONSIDERATION.EFFECTIVE_FROM_DATE",
"identity": "source-PIR"
}, {
"map": "effectiveFrom",
"identity": "source-PHSL"
} ]
}, {
"id": "CarePlan.period.end",
"path": "CarePlan.period.end",
"comment": "See Mappings",
"mapping": [ {
"map": "SPECIAL_CONSIDERATION.EFFECTIVE_TO_DATE",
"identity": "source-PIR"
}, {
"map": "effectiveTo",
"identity": "source-PHSL"
} ]
}, {
"id": "CarePlan.contributor",
"max": "1",
"path": "CarePlan.contributor"
}, {
"id": "CarePlan.careTeam",
"max": "1",
"path": "CarePlan.careTeam"
}, {
"id": "CarePlan.addresses",
"max": "1",
"path": "CarePlan.addresses"
}, {
"id": "CarePlan.supportingInfo",
"max": "1",
"path": "CarePlan.supportingInfo"
}, {
"id": "CarePlan.goal",
"max": "1",
"path": "CarePlan.goal"
}, {
"id": "CarePlan.activity",
"max": "1",
"min": 1,
"path": "CarePlan.activity"
}, {
"id": "CarePlan.activity.outcomeCodeableConcept",
"max": "1",
"path": "CarePlan.activity.outcomeCodeableConcept"
}, {
"id": "CarePlan.activity.outcomeReference",
"max": "1",
"path": "CarePlan.activity.outcomeReference"
}, {
"id": "CarePlan.activity.progress",
"max": "1",
"path": "CarePlan.activity.progress"
}, {
"id": "CarePlan.activity.detail",
"min": 1,
"path": "CarePlan.activity.detail"
}, {
"id": "CarePlan.activity.detail.instantiatesCanonical",
"max": "1",
"path": "CarePlan.activity.detail.instantiatesCanonical"
}, {
"id": "CarePlan.activity.detail.instantiatesUri",
"max": "1",
"path": "CarePlan.activity.detail.instantiatesUri"
}, {
"id": "CarePlan.activity.detail.reasonCode",
"max": "1",
"path": "CarePlan.activity.detail.reasonCode"
}, {
"id": "CarePlan.activity.detail.reasonReference",
"max": "1",
"min": 1,
"path": "CarePlan.activity.detail.reasonReference"
}, {
"id": "CarePlan.activity.detail.reasonReference.reference",
"min": 1,
"path": "CarePlan.activity.detail.reasonReference.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "\"#Condition\"+ (PIR SC ID)",
"identity": "source-PIR"
} ]
}, {
"id": "CarePlan.activity.detail.goal",
"max": "1",
"path": "CarePlan.activity.detail.goal"
}, {
"id": "CarePlan.activity.detail.status",
"path": "CarePlan.activity.detail.status",
"short": "PIR applies | completed | for FHIR purposes.",
"comment": "Apply \"completed\"",
"definition": "PIR applies | completed | for FHIR purposes."
}, {
"id": "CarePlan.activity.detail.location.reference",
"min": 1,
"path": "CarePlan.activity.detail.location.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "\"#Location/\"(SDL_ID)+\"org\"+(BRANCH_ID)",
"identity": "source-HA"
}, {
"map": "fullURL+\"Location/\"+(SDL_ID)+\"org\"+(BRANCH_ID)",
"comment": "http://ehealth.bc.ca/eform/fhir",
"identity": "source-eForm"
} ]
}, {
"id": "CarePlan.activity.detail.location.type",
"max": "0",
"path": "CarePlan.activity.detail.location.type"
}, {
"id": "CarePlan.activity.detail.location.identifier",
"max": "0",
"path": "CarePlan.activity.detail.location.identifier"
}, {
"id": "CarePlan.activity.detail.location.display",
"max": "0",
"path": "CarePlan.activity.detail.location.display"
}, {
"id": "CarePlan.activity.detail.performer",
"max": "1",
"path": "CarePlan.activity.detail.performer"
}, {
"id": "CarePlan.activity.detail.product[x]",
"min": 1,
"path": "CarePlan.activity.detail.product[x]",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The agent/antigen to be applied for special consideration.",
"definition": "Identifies the vaccine agent or antiger to apply special consideration for."
}, {
"id": "CarePlan.activity.detail.product[x].coding",
"max": "1",
"min": 1,
"path": "CarePlan.activity.detail.product[x].coding",
"comment": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code"
}, {
"id": "CarePlan.activity.detail.product[x].coding.system",
"min": 1,
"path": "CarePlan.activity.detail.product[x].coding.system",
"short": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code",
"comment": "See Mappings",
"mapping": [ {
"map": "https://nvc-cnv.canada.ca",
"identity": "code-NVC"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code",
"identity": "code-PIR"
} ],
"definition": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code"
}, {
"id": "CarePlan.activity.detail.product[x].coding.code",
"min": 1,
"path": "CarePlan.activity.detail.product[x].coding.code",
"comment": "See Mappings",
"mapping": [ {
"map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(sc.AGENT_CD_CNCPT_ID)",
"identity": "source-PIR-code-agent"
}, {
"map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)",
"identity": "source-PIR-code-antigen"
}, {
"map": "agent",
"identity": "source-PHSL-agent"
}, {
"map": "antigen",
"identity": "source-PHSL-antigen"
} ]
}, {
"id": "CarePlan.activity.detail.product[x].coding.display",
"min": 1,
"path": "CarePlan.activity.detail.product[x].coding.display",
"comment": "See Mappings",
"mapping": [ {
"map": "REPORTNG.GET_ITERM_DESC(sc.AGENT_CD_CNCPT_ID)",
"identity": "source-PIR-code-agent"
}, {
"map": "REPORTNG.GET_ITERM_DESC(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)",
"identity": "source-PIR-code-antigen"
}, {
"map": "agentDescription",
"identity": "source-PHSL-agent"
}, {
"map": "antigenDescription",
"identity": "source-PHSL-antigen"
} ]
}, {
"id": "CarePlan.note",
"path": "CarePlan.note",
"short": "Comments about the special consideration",
"comment": "Comments about the special consideration",
"definition": "Comments about the special consideration"
}, {
"id": "CarePlan.note.id",
"max": "0",
"path": "CarePlan.note.id"
}, {
"id": "CarePlan.note.author[x]",
"max": "0",
"path": "CarePlan.note.author[x]"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}