{
"description": null,
"_filename": "Consent.StructureDefinition.json",
"package_name": "BC",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "Consent",
"abstract": false,
"type": "Consent",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "BCY_IDS.01-1.0.0",
"status": "draft",
"id": "7ae4fd7a-e9fa-44bc-9b6d-6d81db4545cd",
"kind": "resource",
"url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Consent",
"version": null,
"differential": {
"element": [ {
"id": "Consent.id",
"min": 1,
"path": "Consent.id",
"comment": "See Mappings",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.CONSENT_DIRECTIVE_ID",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.meta",
"path": "Consent.meta"
}, {
"id": "Consent.meta.id",
"max": "0",
"path": "Consent.meta.id"
}, {
"id": "Consent.meta.versionId",
"path": "Consent.meta.versionId",
"comment": "Apply \"2024.04\". This indicates the FHIR Specs as of year 2024 April."
}, {
"id": "Consent.meta.lastUpdated",
"max": "0",
"path": "Consent.meta.lastUpdated"
}, {
"id": "Consent.meta.source",
"max": "0",
"path": "Consent.meta.source"
}, {
"id": "Consent.meta.profile",
"max": "1",
"min": 1,
"path": "Consent.meta.profile",
"comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Consent\""
}, {
"id": "Consent.meta.security",
"max": "0",
"path": "Consent.meta.security"
}, {
"id": "Consent.meta.tag",
"max": "0",
"path": "Consent.meta.tag"
}, {
"id": "Consent.implicitRules",
"max": "0",
"path": "Consent.implicitRules"
}, {
"id": "Consent.language",
"max": "0",
"path": "Consent.language"
}, {
"id": "Consent.text",
"max": "0",
"path": "Consent.text"
}, {
"id": "Consent.contained",
"min": 1,
"path": "Consent.contained",
"type": [ {
"code": "Resource",
"profile": [ "RelatedPerson", "PractitionerConsentGivenTo" ]
} ]
}, {
"id": "Consent.extension:consentExtension",
"path": "Consent.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/consent-type-form-doses-comments" ]
} ],
"sliceName": "consentExtension"
}, {
"id": "Consent.identifier",
"max": "1",
"min": 1,
"path": "Consent.identifier"
}, {
"id": "Consent.identifier.id",
"max": "0",
"path": "Consent.identifier.id"
}, {
"id": "Consent.identifier.use",
"max": "0",
"path": "Consent.identifier.use"
}, {
"id": "Consent.identifier.type",
"min": 1,
"path": "Consent.identifier.type"
}, {
"id": "Consent.identifier.type.id",
"max": "0",
"path": "Consent.identifier.type.id"
}, {
"id": "Consent.identifier.type.coding",
"max": "0",
"path": "Consent.identifier.type.coding"
}, {
"id": "Consent.identifier.type.text",
"min": 1,
"path": "Consent.identifier.type.text",
"comment": "See Mappings",
"mapping": [ {
"map": "\"PANORAMACONSENTID\"",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.identifier.system",
"min": 1,
"path": "Consent.identifier.system",
"comment": "See Mappings",
"mapping": [ {
"map": "\"https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-document-number\"",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.identifier.value",
"min": 1,
"path": "Consent.identifier.value",
"comment": "See Mappings",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.CONSENT_DIRECTIVE_ID",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.identifier.period",
"max": "0",
"path": "Consent.identifier.period"
}, {
"id": "Consent.identifier.assigner",
"max": "0",
"path": "Consent.identifier.assigner"
}, {
"id": "Consent.status",
"code": [ {
"code": "active",
"system": "http://hl7.org/fhir/ValueSet/consent-state-codes"
} ],
"path": "Consent.status",
"comment": "Confirmed (PIR) maps to Active (FHIR). See Mappings.",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.DIRECTIVE_STATUS_CODE_CNCPT_ID",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.scope.id",
"max": "0",
"path": "Consent.scope.id"
}, {
"id": "Consent.scope.coding",
"min": 1,
"path": "Consent.scope.coding"
}, {
"id": "Consent.scope.coding.id",
"max": "0",
"path": "Consent.scope.coding.id"
}, {
"id": "Consent.scope.coding.system",
"min": 1,
"code": [ {
"system": "http://terminology.hl7.org/CodeSystem/consentscope"
} ],
"path": "Consent.scope.coding.system",
"comment": "See Code"
}, {
"id": "Consent.scope.coding.version",
"max": "0",
"path": "Consent.scope.coding.version"
}, {
"id": "Consent.scope.coding.code",
"min": 1,
"path": "Consent.scope.coding.code",
"comment": "Apply \"treatment\""
}, {
"id": "Consent.scope.coding.display",
"max": "0",
"path": "Consent.scope.coding.display"
}, {
"id": "Consent.scope.coding.userSelected",
"max": "0",
"path": "Consent.scope.coding.userSelected"
}, {
"id": "Consent.scope.text",
"max": "0",
"path": "Consent.scope.text"
}, {
"id": "Consent.category.id",
"max": "0",
"path": "Consent.category.id"
}, {
"id": "Consent.category.coding.id",
"max": "0",
"path": "Consent.category.coding.id"
}, {
"id": "Consent.category.coding.system",
"min": 1,
"code": [ {
"system": "http://loinc.org"
} ],
"path": "Consent.category.coding.system",
"comment": "See Code"
}, {
"id": "Consent.category.coding.version",
"max": "0",
"path": "Consent.category.coding.version"
}, {
"id": "Consent.category.coding.code",
"min": 1,
"path": "Consent.category.coding.code",
"comment": "Apply \"59284-0\""
}, {
"id": "Consent.category.coding.display",
"max": "0",
"path": "Consent.category.coding.display"
}, {
"id": "Consent.category.coding.userSelected",
"max": "0",
"path": "Consent.category.coding.userSelected"
}, {
"id": "Consent.category.text",
"max": "0",
"path": "Consent.category.text"
}, {
"id": "Consent.patient.id",
"max": "0",
"path": "Consent.patient.id"
}, {
"id": "Consent.patient.reference",
"min": 1,
"path": "Consent.patient.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "fullURL + \"Patient/\" + (Patient ID)",
"comment": "e.g. http://ehealth.bc.ca/panorama/fhir/Patient/59900999\"",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.patient.type",
"max": "0",
"path": "Consent.patient.type"
}, {
"id": "Consent.patient.identifier",
"max": "0",
"path": "Consent.patient.identifier"
}, {
"id": "Consent.patient.display",
"max": "0",
"path": "Consent.patient.display"
}, {
"id": "Consent.dateTime",
"max": "0",
"path": "Consent.dateTime"
}, {
"id": "Consent.performer",
"max": "1",
"path": "Consent.performer"
}, {
"id": "Consent.performer.id",
"max": "0",
"path": "Consent.performer.id"
}, {
"id": "Consent.performer.reference",
"min": 1,
"path": "Consent.performer.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "\"#RelatedPerson\"+(CONSENT.CONSENT_DIRECTIVE.CONSENT_DIRECTIVE_ID)\"",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.performer.type",
"max": "0",
"path": "Consent.performer.type"
}, {
"id": "Consent.performer.identifier",
"max": "0",
"path": "Consent.performer.identifier"
}, {
"id": "Consent.performer.display",
"max": "0",
"path": "Consent.performer.display"
}, {
"id": "Consent.organization",
"max": "0",
"path": "Consent.organization"
}, {
"id": "Consent.source[x]",
"max": "0",
"path": "Consent.source[x]"
}, {
"id": "Consent.policy",
"max": "0",
"path": "Consent.policy"
}, {
"id": "Consent.policyRule",
"min": 1,
"path": "Consent.policyRule"
}, {
"id": "Consent.policyRule.id",
"max": "0",
"path": "Consent.policyRule.id"
}, {
"id": "Consent.policyRule.coding",
"min": 1,
"path": "Consent.policyRule.coding"
}, {
"id": "Consent.policyRule.coding.id",
"max": "0",
"path": "Consent.policyRule.coding.id"
}, {
"id": "Consent.policyRule.coding.system",
"min": 1,
"code": [ {
"system": "http://terminology.hl7.org/CodeSystem/consentpolicycodes"
} ],
"path": "Consent.policyRule.coding.system",
"comment": "See Code"
}, {
"id": "Consent.policyRule.coding.version",
"max": "0",
"path": "Consent.policyRule.coding.version"
}, {
"id": "Consent.policyRule.coding.code",
"min": 1,
"path": "Consent.policyRule.coding.code",
"comment": "Apply \"cric\" (Common Rule Informed Consent)."
}, {
"id": "Consent.policyRule.coding.display",
"max": "0",
"path": "Consent.policyRule.coding.display"
}, {
"id": "Consent.policyRule.coding.userSelected",
"max": "0",
"path": "Consent.policyRule.coding.userSelected"
}, {
"id": "Consent.verification",
"max": "0",
"path": "Consent.verification"
}, {
"id": "Consent.provision",
"min": 1,
"path": "Consent.provision"
}, {
"id": "Consent.provision.id",
"max": "0",
"path": "Consent.provision.id"
}, {
"id": "Consent.provision.type",
"max": "0",
"path": "Consent.provision.type"
}, {
"id": "Consent.provision.period",
"min": 1,
"path": "Consent.provision.period"
}, {
"id": "Consent.provision.period.id",
"max": "0",
"path": "Consent.provision.period.id"
}, {
"id": "Consent.provision.period.start",
"min": 1,
"path": "Consent.provision.period.start",
"comment": "See Mappings.",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.EFFECT_FROM_DATE",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.provision.period.end",
"path": "Consent.provision.period.end",
"comment": "See Mappings",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.EFFECT_TO_DATE",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.provision.actor.id",
"max": "0",
"path": "Consent.provision.actor.id"
}, {
"id": "Consent.provision.actor.role.id",
"max": "0",
"path": "Consent.provision.actor.role.id"
}, {
"id": "Consent.provision.actor.role.coding",
"min": 1,
"path": "Consent.provision.actor.role.coding"
}, {
"id": "Consent.provision.actor.role.coding.id",
"max": "0",
"path": "Consent.provision.actor.role.coding.id"
}, {
"id": "Consent.provision.actor.role.coding.system",
"min": 1,
"code": [ {
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
} ],
"path": "Consent.provision.actor.role.coding.system"
}, {
"id": "Consent.provision.actor.role.coding.version",
"max": "0",
"path": "Consent.provision.actor.role.coding.version"
}, {
"id": "Consent.provision.actor.role.coding.code",
"min": 1,
"path": "Consent.provision.actor.role.coding.code",
"comment": "Apply \"CONSENTER\""
}, {
"id": "Consent.provision.actor.role.coding.display",
"max": "0",
"path": "Consent.provision.actor.role.coding.display"
}, {
"id": "Consent.provision.actor.role.coding.userSelected",
"max": "0",
"path": "Consent.provision.actor.role.coding.userSelected"
}, {
"id": "Consent.provision.actor.role.text",
"max": "0",
"path": "Consent.provision.actor.role.text"
}, {
"id": "Consent.provision.actor.reference.id",
"max": "0",
"path": "Consent.provision.actor.reference.id"
}, {
"id": "Consent.provision.actor.reference.reference",
"min": 1,
"path": "Consent.provision.actor.reference.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "\"#PractitionerConsentGivenTo\"+(CONSENT.CONSENT_DIRECTIVE.CONSENT_DIRECTIVE_ID)\"",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.provision.actor.reference.type",
"max": "0",
"path": "Consent.provision.actor.reference.type"
}, {
"id": "Consent.provision.actor.reference.identifier",
"max": "0",
"path": "Consent.provision.actor.reference.identifier"
}, {
"id": "Consent.provision.actor.reference.display",
"max": "0",
"path": "Consent.provision.actor.reference.display"
}, {
"id": "Consent.provision.action",
"max": "1",
"min": 1,
"path": "Consent.provision.action",
"short": "Consent or Refusal",
"definition": "Consent or Refusal"
}, {
"id": "Consent.provision.action.id",
"max": "0",
"path": "Consent.provision.action.id"
}, {
"id": "Consent.provision.action.coding",
"min": 1,
"path": "Consent.provision.action.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "code",
"type": "value"
} ]
}
}, {
"id": "Consent.provision.action.coding.id",
"max": "0",
"path": "Consent.provision.action.coding.id"
}, {
"id": "Consent.provision.action.coding:sliceConsentInstruction",
"max": "1",
"min": 1,
"path": "Consent.provision.action.coding",
"sliceName": "sliceConsentInstruction"
}, {
"id": "Consent.provision.action.coding:sliceConsentInstruction.id",
"max": "0",
"path": "Consent.provision.action.coding.id"
}, {
"id": "Consent.provision.action.coding:sliceConsentInstruction.system",
"min": 1,
"code": [ {
"system": "http://hl7.org/fhir/sid/icd9"
} ],
"path": "Consent.provision.action.coding.system",
"comment": "See Code"
}, {
"id": "Consent.provision.action.coding:sliceConsentInstruction.version",
"max": "0",
"path": "Consent.provision.action.coding.version"
}, {
"id": "Consent.provision.action.coding:sliceConsentInstruction.code",
"min": 1,
"path": "Consent.provision.action.coding.code",
"comment": "G | R.\r\nRefer to IMMS codeset spreadsheet: Consent - Instruction. See Mappings.",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.CONSENT_VALUE_CODED_CNCPT_ID",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.provision.action.coding:sliceConsentInstruction.display",
"min": 1,
"path": "Consent.provision.action.coding.display",
"comment": "Grant | Refuse"
}, {
"id": "Consent.provision.action.coding:sliceConsentInstruction.userSelected",
"max": "0",
"path": "Consent.provision.action.coding.userSelected"
}, {
"id": "Consent.provision.action.coding:sliceConsentRefusalReaason",
"max": "1",
"min": 1,
"path": "Consent.provision.action.coding",
"sliceName": "sliceConsentRefusalReaason"
}, {
"id": "Consent.provision.action.coding:sliceConsentRefusalReaason.id",
"max": "0",
"path": "Consent.provision.action.coding.id"
}, {
"id": "Consent.provision.action.coding:sliceConsentRefusalReaason.system",
"min": 1,
"code": [ {
"system": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-consent-refusal-reason"
} ],
"path": "Consent.provision.action.coding.system",
"comment": "See Code"
}, {
"id": "Consent.provision.action.coding:sliceConsentRefusalReaason.version",
"max": "0",
"path": "Consent.provision.action.coding.version"
}, {
"id": "Consent.provision.action.coding:sliceConsentRefusalReaason.code",
"min": 1,
"path": "Consent.provision.action.coding.code",
"comment": "Refer to IMMS codeset spreadsheet: Consent - Reason. See Mappings",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.REFUSAL_REASON_CODE_CNCPT_ID",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.provision.action.coding:sliceConsentRefusalReaason.display",
"min": 1,
"path": "Consent.provision.action.coding.display",
"comment": "Refer to IMMS codeset spreadsheet: Consent - Reason"
}, {
"id": "Consent.provision.action.coding:sliceConsentRefusalReaason.userSelected",
"max": "0",
"path": "Consent.provision.action.coding.userSelected"
}, {
"id": "Consent.provision.action.text",
"path": "Consent.provision.action.text",
"comment": "Mandatory if Reason for Refusal = \"O\"ther. See Mappings.",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.REFUSAL_REASON_OTHER",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.provision.securityLabel",
"max": "0",
"path": "Consent.provision.securityLabel"
}, {
"id": "Consent.provision.purpose",
"max": "0",
"path": "Consent.provision.purpose"
}, {
"id": "Consent.provision.class",
"max": "0",
"path": "Consent.provision.class"
}, {
"id": "Consent.provision.code",
"min": 1,
"path": "Consent.provision.code"
}, {
"id": "Consent.provision.code.id",
"max": "0",
"path": "Consent.provision.code.id"
}, {
"id": "Consent.provision.code.coding",
"min": 1,
"path": "Consent.provision.code.coding"
}, {
"id": "Consent.provision.code.coding.id",
"max": "0",
"path": "Consent.provision.code.coding.id"
}, {
"id": "Consent.provision.code.coding.system",
"min": 1,
"path": "Consent.provision.code.coding.system",
"comment": "See Mappings",
"mapping": [ {
"map": "https://nvc-cnv.canada.ca",
"identity": "code-NVC"
}, {
"map": "http://snomed.info/sct",
"identity": "code-SNOMED"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code",
"identity": "code-PIR"
} ]
}, {
"id": "Consent.provision.code.coding.version",
"max": "0",
"path": "Consent.provision.code.coding.version"
}, {
"id": "Consent.provision.code.coding.code",
"min": 1,
"path": "Consent.provision.code.coding.code",
"comment": "Enter Vaccine code for both consent and Consent Refussal. See Mappings.",
"mapping": [ {
"map": "CONSENT.CONSENT_DIRECTIVE.DIRECTIVE_ANTIGEN_ID",
"identity": "source-PIR"
} ]
}, {
"id": "Consent.provision.code.coding.display",
"min": 1,
"path": "Consent.provision.code.coding.display",
"comment": "Enter Vaccine Name for Consent or Consent Refussal"
}, {
"id": "Consent.provision.code.coding.userSelected",
"max": "0",
"path": "Consent.provision.code.coding.userSelected"
}, {
"id": "Consent.provision.code.text",
"max": "0",
"path": "Consent.provision.code.text"
}, {
"id": "Consent.provision.dataPeriod",
"max": "0",
"path": "Consent.provision.dataPeriod"
}, {
"id": "Consent.provision.data",
"max": "0",
"path": "Consent.provision.data"
}, {
"id": "Consent.provision.provision",
"max": "0",
"path": "Consent.provision.provision"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent"
}