FHIR IG analytics| Package | bcy.ids |
| Resource Type | StructureDefinition |
| Id | CarePlan.StructureDefinition.json |
| FHIR Version | R4 |
No resources found
No resources found
No narrative content found in resource
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"meta": {
"versionId": "7",
"lastUpdated": "2025-12-08T19:19:39.1260749+00:00"
},
"url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan",
"name": "CarePlan",
"status": "draft",
"date": "2022-03-04T22:33:55.2668635+00:00",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "CarePlan",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CarePlan",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "CarePlan",
"path": "CarePlan",
"short": "FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution",
"definition": "FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution",
"comment": "resourceCarePlan contains resourceCondition for PIR Special Considerations data."
},
{
"id": "CarePlan.id",
"path": "CarePlan.id",
"short": "PIR internal Special Consideration ID",
"definition": "PIR internal Special Consideration Identifier",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "SPECIAL_CONSIDERATION.CONTRA_ID"
},
{
"identity": "source-PHSL",
"map": "specialConsiderationId"
}
]
},
{
"id": "CarePlan.meta",
"path": "CarePlan.meta",
"min": 1
},
{
"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",
"path": "CarePlan.meta.profile",
"comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan\"",
"min": 1,
"max": "1"
},
{
"id": "CarePlan.meta.security",
"path": "CarePlan.meta.security",
"max": "1"
},
{
"id": "CarePlan.meta.tag",
"path": "CarePlan.meta.tag",
"max": "1"
},
{
"id": "CarePlan.contained",
"path": "CarePlan.contained",
"short": "Contains resourceCondition as part of PIR Special Consideration",
"definition": "Contains resourceCondition as part of PIR Special Consideration",
"comment": "resourceCondition is part of PIR Special Consideration",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource",
"profile": [
"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Condition"
]
}
]
},
{
"id": "CarePlan.extension",
"path": "CarePlan.extension",
"min": 2
},
{
"id": "CarePlan.extension:pIRIdentifierExtension",
"path": "CarePlan.extension",
"sliceName": "pIRIdentifierExtension",
"type": [
{
"code": "Extension",
"profile": [
"https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier"
]
}
],
"isModifier": false
},
{
"id": "CarePlan.extension:pIRLockSeqNumberExtension",
"path": "CarePlan.extension",
"sliceName": "pIRLockSeqNumberExtension",
"type": [
{
"code": "Extension",
"profile": [
"https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number"
]
}
],
"isModifier": false
},
{
"id": "CarePlan.identifier",
"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)",
"min": 1,
"max": "1"
},
{
"id": "CarePlan.identifier.type",
"path": "CarePlan.identifier.type",
"min": 1
},
{
"id": "CarePlan.identifier.type.coding",
"path": "CarePlan.identifier.type.coding",
"max": "1"
},
{
"id": "CarePlan.identifier.type.text",
"path": "CarePlan.identifier.type.text",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "\"PANORAMASCID\""
}
]
},
{
"id": "CarePlan.identifier.system",
"path": "CarePlan.identifier.system",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-special-consideration-id"
}
]
},
{
"id": "CarePlan.identifier.value",
"path": "CarePlan.identifier.value",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "SPECIAL_CONSIDERATION.CONTRA_ID"
},
{
"identity": "source-PHSL",
"map": "specialConsiderationId"
}
]
},
{
"id": "CarePlan.instantiatesCanonical",
"path": "CarePlan.instantiatesCanonical",
"max": "1"
},
{
"id": "CarePlan.instantiatesUri",
"path": "CarePlan.instantiatesUri",
"max": "1"
},
{
"id": "CarePlan.basedOn",
"path": "CarePlan.basedOn",
"max": "1"
},
{
"id": "CarePlan.replaces",
"path": "CarePlan.replaces",
"max": "1"
},
{
"id": "CarePlan.partOf",
"path": "CarePlan.partOf",
"max": "1"
},
{
"id": "CarePlan.status",
"path": "CarePlan.status",
"short": "Possible status from PIR: | revoked | completed |",
"definition": "Possible status from PIR: | revoked | completed |. Revoked = deleted. Completed = active.",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR-active",
"map": "completed"
},
{
"identity": "source-PIR-deleted",
"map": "revoked"
}
]
},
{
"id": "CarePlan.status.extension:_status",
"path": "CarePlan.status.extension",
"sliceName": "_status",
"comment": "To be applied when Special Consideration is deleted in PIR.",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status"
]
}
],
"isModifier": false
},
{
"id": "CarePlan.status.extension:_status.extension:scDeleteReason",
"path": "CarePlan.status.extension.extension",
"sliceName": "scDeleteReason",
"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": [
{
"identity": "source-PIR-nullReason",
"map": "Other"
}
]
},
{
"id": "CarePlan.status.extension:_status.extension:scDeleteReasonOther",
"path": "CarePlan.status.extension.extension",
"sliceName": "scDeleteReasonOther",
"comment": "To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list. See Mappings.",
"mapping": [
{
"identity": "source-PIR-null",
"map": "unknown"
}
]
},
{
"id": "CarePlan.intent",
"path": "CarePlan.intent",
"short": "PIR applies value | order | for FHIR purposes only.",
"definition": "PIR applies value | order | for FHIR purposes only.",
"comment": "Apply \"order\""
},
{
"id": "CarePlan.category",
"path": "CarePlan.category",
"max": "1"
},
{
"id": "CarePlan.subject.reference",
"path": "CarePlan.subject.reference",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "fullURL + \"Patient/\" + (Patient ID)"
}
]
},
{
"id": "CarePlan.period",
"path": "CarePlan.period",
"min": 1
},
{
"id": "CarePlan.period.id",
"path": "CarePlan.period.id",
"max": "0"
},
{
"id": "CarePlan.period.start",
"path": "CarePlan.period.start",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "SPECIAL_CONSIDERATION.EFFECTIVE_FROM_DATE"
},
{
"identity": "source-PHSL",
"map": "effectiveFrom"
}
]
},
{
"id": "CarePlan.period.end",
"path": "CarePlan.period.end",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "SPECIAL_CONSIDERATION.EFFECTIVE_TO_DATE"
},
{
"identity": "source-PHSL",
"map": "effectiveTo"
}
]
},
{
"id": "CarePlan.contributor",
"path": "CarePlan.contributor",
"max": "1"
},
{
"id": "CarePlan.careTeam",
"path": "CarePlan.careTeam",
"max": "1"
},
{
"id": "CarePlan.addresses",
"path": "CarePlan.addresses",
"max": "1"
},
{
"id": "CarePlan.supportingInfo",
"path": "CarePlan.supportingInfo",
"max": "1"
},
{
"id": "CarePlan.goal",
"path": "CarePlan.goal",
"max": "1"
},
{
"id": "CarePlan.activity",
"path": "CarePlan.activity",
"min": 1,
"max": "1"
},
{
"id": "CarePlan.activity.outcomeCodeableConcept",
"path": "CarePlan.activity.outcomeCodeableConcept",
"max": "1"
},
{
"id": "CarePlan.activity.outcomeReference",
"path": "CarePlan.activity.outcomeReference",
"max": "1"
},
{
"id": "CarePlan.activity.progress",
"path": "CarePlan.activity.progress",
"max": "1"
},
{
"id": "CarePlan.activity.detail",
"path": "CarePlan.activity.detail",
"min": 1
},
{
"id": "CarePlan.activity.detail.instantiatesCanonical",
"path": "CarePlan.activity.detail.instantiatesCanonical",
"max": "1"
},
{
"id": "CarePlan.activity.detail.instantiatesUri",
"path": "CarePlan.activity.detail.instantiatesUri",
"max": "1"
},
{
"id": "CarePlan.activity.detail.reasonCode",
"path": "CarePlan.activity.detail.reasonCode",
"max": "1"
},
{
"id": "CarePlan.activity.detail.reasonReference",
"path": "CarePlan.activity.detail.reasonReference",
"min": 1,
"max": "1"
},
{
"id": "CarePlan.activity.detail.reasonReference.reference",
"path": "CarePlan.activity.detail.reasonReference.reference",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "\"#Condition\"+ (PIR SC ID)"
}
]
},
{
"id": "CarePlan.activity.detail.goal",
"path": "CarePlan.activity.detail.goal",
"max": "1"
},
{
"id": "CarePlan.activity.detail.status",
"path": "CarePlan.activity.detail.status",
"short": "PIR applies | completed | for FHIR purposes.",
"definition": "PIR applies | completed | for FHIR purposes.",
"comment": "Apply \"completed\""
},
{
"id": "CarePlan.activity.detail.location.reference",
"path": "CarePlan.activity.detail.location.reference",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-HA",
"map": "\"#Location/\"(SDL_ID)+\"org\"+(BRANCH_ID)"
},
{
"identity": "source-eForm",
"map": "fullURL+\"Location/\"+(SDL_ID)+\"org\"+(BRANCH_ID)",
"comment": "http://ehealth.bc.ca/eform/fhir"
}
]
},
{
"id": "CarePlan.activity.detail.location.type",
"path": "CarePlan.activity.detail.location.type",
"max": "0"
},
{
"id": "CarePlan.activity.detail.location.identifier",
"path": "CarePlan.activity.detail.location.identifier",
"max": "0"
},
{
"id": "CarePlan.activity.detail.location.display",
"path": "CarePlan.activity.detail.location.display",
"max": "0"
},
{
"id": "CarePlan.activity.detail.performer",
"path": "CarePlan.activity.detail.performer",
"max": "1"
},
{
"id": "CarePlan.activity.detail.product[x]",
"path": "CarePlan.activity.detail.product[x]",
"short": "The agent/antigen to be applied for special consideration.",
"definition": "Identifies the vaccine agent or antiger to apply special consideration for.",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "CarePlan.activity.detail.product[x].coding",
"path": "CarePlan.activity.detail.product[x].coding",
"comment": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code",
"min": 1,
"max": "1"
},
{
"id": "CarePlan.activity.detail.product[x].coding.system",
"path": "CarePlan.activity.detail.product[x].coding.system",
"short": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code",
"definition": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code",
"comment": "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": "CarePlan.activity.detail.product[x].coding.code",
"path": "CarePlan.activity.detail.product[x].coding.code",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR-code-agent",
"map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(sc.AGENT_CD_CNCPT_ID)"
},
{
"identity": "source-PIR-code-antigen",
"map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)"
},
{
"identity": "source-PHSL-agent",
"map": "agent"
},
{
"identity": "source-PHSL-antigen",
"map": "antigen"
}
]
},
{
"id": "CarePlan.activity.detail.product[x].coding.display",
"path": "CarePlan.activity.detail.product[x].coding.display",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR-code-agent",
"map": "REPORTNG.GET_ITERM_DESC(sc.AGENT_CD_CNCPT_ID)"
},
{
"identity": "source-PIR-code-antigen",
"map": "REPORTNG.GET_ITERM_DESC(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)"
},
{
"identity": "source-PHSL-agent",
"map": "agentDescription"
},
{
"identity": "source-PHSL-antigen",
"map": "antigenDescription"
}
]
},
{
"id": "CarePlan.note",
"path": "CarePlan.note",
"short": "Comments about the special consideration",
"definition": "Comments about the special consideration",
"comment": "Comments about the special consideration"
},
{
"id": "CarePlan.note.id",
"path": "CarePlan.note.id",
"max": "0"
},
{
"id": "CarePlan.note.extension",
"path": "CarePlan.note.extension",
"min": 2
},
{
"id": "CarePlan.note.extension:pIRIdentifierExtension",
"path": "CarePlan.note.extension",
"sliceName": "pIRIdentifierExtension",
"type": [
{
"code": "Extension",
"profile": [
"https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier"
]
}
],
"isModifier": false
},
{
"id": "CarePlan.note.extension:pIRLockSeqNumberExtension",
"path": "CarePlan.note.extension",
"sliceName": "pIRLockSeqNumberExtension",
"type": [
{
"code": "Extension",
"profile": [
"https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number"
]
}
],
"isModifier": false
},
{
"id": "CarePlan.note.author[x]",
"path": "CarePlan.note.author[x]",
"max": "0"
}
]
}
}