{
"description": "CancerRegimens",
"_filename": "StructureDefinition-CancerRegimensLM.json",
"package_name": "hl7.fhir.nz.cca",
"date": "2020-10-27T14:38:03+13:00",
"derivation": "specialization",
"meta": {
"versionId": "17",
"lastUpdated": "2020-10-27T14:40:48.207+13:00"
},
"publisher": "David Hay",
"fhirVersion": "4.0.1",
"purpose": "CancerRegimens",
"name": "CancerRegimensLM",
"mapping": [ {
"name": "FHIR artifacts",
"identity": "fhir"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "CancerRegimens",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "CancerRegimensLM",
"package_version": "0.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CancerRegimens",
"min": 1,
"definition": "No description",
"isModifier": false,
"short": "Base for all elements",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "1",
"id": "CancerRegimens",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element"
}
}, {
"path": "CancerRegimens.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CancerRegimens.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CancerRegimens.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CancerRegimens.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "CancerRegimens.status",
"min": 0,
"definition": "The overall status for the regimen. Includes that the regimen is approved for use (status=active) but is still under review so may change.",
"short": "status",
"mapping": [ {
"map": "PlanDefinition.status \nThere is an extension (regimen-under-review) on status that indicates that the regimen is under review. The actual status value will be 'active'.",
"identity": "fhir"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"max": "1",
"label": "status",
"id": "CancerRegimens.status",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.status"
}
}, {
"path": "CancerRegimens.version",
"min": 0,
"definition": "The version of the regimen",
"short": "version",
"mapping": [ {
"map": "PlanDefinition.version",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "version",
"id": "CancerRegimens.version",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.version"
}
}, {
"path": "CancerRegimens.title",
"min": 0,
"definition": "A short title that describes the regimen, suitable for a display",
"short": "title",
"mapping": [ {
"map": "PlanDefinition.title",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "title",
"id": "CancerRegimens.title",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.title"
}
}, {
"path": "CancerRegimens.description",
"min": 0,
"definition": "A more detailed description",
"short": "description",
"mapping": [ {
"map": "PlanDefinition.description",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "description",
"id": "CancerRegimens.description",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.description"
}
}, {
"path": "CancerRegimens.instructions",
"min": 0,
"definition": "Overall instructions for use. Distinct from the description of the regimen",
"short": "instructions",
"mapping": [ {
"map": "PlanDefinition.extension[plan-instructions]",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "instructions",
"id": "CancerRegimens.instructions",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.instructions"
}
}, {
"path": "CancerRegimens.publisher",
"min": 0,
"definition": "The organisation responsible for publishing the regimen",
"short": "publisher",
"mapping": [ {
"map": "PlanDefinition.publisher",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "publisher",
"id": "CancerRegimens.publisher",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.publisher"
}
}, {
"path": "CancerRegimens.date",
"min": 0,
"definition": "When the regimen was first made available for use",
"short": "date",
"mapping": [ {
"map": "PlanDefinition.date",
"identity": "fhir"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"label": "date",
"id": "CancerRegimens.date",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.date"
}
}, {
"path": "CancerRegimens.type",
"min": 0,
"definition": "The type od regimen - eg FOLFOX",
"short": "type",
"mapping": [ {
"map": "PlanDefinition.extension[regimenType]",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "type",
"id": "CancerRegimens.type",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.type"
}
}, {
"path": "CancerRegimens.intent",
"min": 0,
"definition": "The intent of the regimen - eg curative or palliative",
"short": "intent",
"mapping": [ {
"map": "PlanDefinition.extension[treatment-intent]",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "intent",
"id": "CancerRegimens.intent",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.intent"
}
}, {
"path": "CancerRegimens.replacedBy",
"min": 0,
"definition": "populated if this regimen is no longer active, but has been replaced by another. Refers directly to the replacement regimen. Note that there is not a reference from the replacement regimen back to this one.",
"short": "replacedBy",
"mapping": [ {
"map": "PlanDefinition.extension[replaced-by]",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "replacedBy",
"id": "CancerRegimens.replacedBy",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.replacedBy"
}
}, {
"path": "CancerRegimens.cancerTypes",
"min": 0,
"definition": "The types of cancer that this regimen is intended to treat. There can be up to 3 - type, subType, subSubType.",
"short": "CancerTypes",
"mapping": [ {
"map": "PlanDefinition.useContext.valueCodeableConcept \nPlanDefinition.useContext.code = \"focus\". Primary, subtype and subsubtype are in order.",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"label": "cancerTypes",
"id": "CancerRegimens.cancerTypes",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes"
}
}, {
"path": "CancerRegimens.cancerTypes.primaryType",
"min": 0,
"definition": "The main cancer that the regimen is targeted to. This will be the first one in the list and will always be present.",
"short": "primaryType",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "primaryType",
"id": "CancerRegimens.cancerTypes.primaryType",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes.primaryType"
}
}, {
"path": "CancerRegimens.cancerTypes.subType",
"min": 0,
"definition": "The cancer sub-type. Will be second in the list, if present.",
"short": "subType",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "subType",
"id": "CancerRegimens.cancerTypes.subType",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes.subType"
}
}, {
"path": "CancerRegimens.cancerTypes.subSubType",
"min": 0,
"definition": "The cancer sub-sub-type. Will be third in the list, if present.",
"short": "subSubType",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "subSubType",
"id": "CancerRegimens.cancerTypes.subSubType",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes.subSubType"
}
}, {
"path": "CancerRegimens.supportFactor",
"min": 0,
"definition": "Factors - such as medications - that may be needed by the patient during a course of treatment - often to counter side-effects of treatment.",
"short": "supportFactor",
"mapping": [ {
"map": "PlanDefinition.extension[support-factor]",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "supportFactor",
"id": "CancerRegimens.supportFactor",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.supportFactor"
}
}, {
"path": "CancerRegimens.supportFactor.type",
"min": 0,
"definition": "The type of sub-factor - eg anti-emetic",
"short": "type",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "type",
"id": "CancerRegimens.supportFactor.type",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.supportFactor.type"
}
}, {
"path": "CancerRegimens.supportFactor.value",
"min": 0,
"definition": "The actual factor - eg a specific anti-emetic",
"short": "value",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "value",
"id": "CancerRegimens.supportFactor.value",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.supportFactor.value"
}
}, {
"path": "CancerRegimens.disclaimer",
"min": 0,
"definition": "Important notes about the regimen to a potential user",
"short": "disclaimer",
"mapping": [ {
"map": "PlanDefinition.extension[disclaimer]",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "disclaimer",
"id": "CancerRegimens.disclaimer",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.disclaimer"
}
}, {
"path": "CancerRegimens.references",
"min": 0,
"definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"short": "relatedArtifact",
"mapping": [ {
"map": "PlanDefinition.relatedArtifact",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "references",
"id": "CancerRegimens.references",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references"
}
}, {
"path": "CancerRegimens.references.type",
"min": 0,
"definition": "The type of related artifact",
"short": "type",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"label": "type",
"id": "CancerRegimens.references.type",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references.type"
}
}, {
"path": "CancerRegimens.references.display",
"min": 0,
"definition": "A string suitable for display",
"short": "display",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "display",
"id": "CancerRegimens.references.display",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references.display"
}
}, {
"path": "CancerRegimens.references.url",
"min": 0,
"definition": "The location where the artefact can be retrieved from",
"short": "url",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"label": "url",
"id": "CancerRegimens.references.url",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references.url"
}
}, {
"path": "CancerRegimens.cycle",
"min": 1,
"definition": "Represents a single cycle of treatment. Note that in the FHIR resource, the cycle is nested...",
"short": "cycle",
"mapping": [ {
"map": "PlanDefinition.action",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "cycle",
"id": "CancerRegimens.cycle",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle"
}
}, {
"path": "CancerRegimens.cycle.description",
"min": 0,
"definition": "A human readable description of what the cycle is. eg \"Cabergoline administration, 2mg over 20 minutes\" repeated weekly for 4 weeks",
"short": "description",
"mapping": [ {
"map": "PlanDefinition.action.description",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "description",
"id": "CancerRegimens.cycle.description",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.description"
}
}, {
"path": "CancerRegimens.cycle.instructions",
"min": 0,
"definition": "Specific instructions for use during this cycle (as opposed to a description OF the cycle)",
"short": "instructions",
"mapping": [ {
"map": "PlanDefinition.action.extension[plan-instructions]",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "instructions",
"id": "CancerRegimens.cycle.instructions",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.instructions"
}
}, {
"path": "CancerRegimens.cycle.duration",
"min": 0,
"definition": "The length of the cycle in days",
"short": "duration",
"mapping": [ {
"map": "PlanDefinition.action.timingTiming",
"identity": "fhir"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "1",
"label": "duration",
"id": "CancerRegimens.cycle.duration",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.duration"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration",
"min": 1,
"definition": "The details of medication administration within this cycle. Details of the administration are in the medication element.",
"short": "medication",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "medicationAdministration",
"id": "CancerRegimens.cycle.medicationAdministration",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.description",
"min": 0,
"definition": "Human description of the medication",
"short": "description",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "description",
"id": "CancerRegimens.cycle.medicationAdministration.description",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.description"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin",
"min": 0,
"definition": "Describes the days within the cycle that the medication is given.",
"short": "dailyAdmin",
"mapping": [ {
"map": "PlanDefinition.action.extension[timing-of-days]",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "dailyAdmin",
"id": "CancerRegimens.cycle.medicationAdministration.dailyAdmin",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber",
"min": 0,
"definition": "The day number for the administration from the start of the cycle",
"short": "dayNumber",
"mapping": [ {
"map": "PlanDefinition.action.extension[timing-of-days].day",
"identity": "fhir"
} ],
"type": [ {
"code": "integer"
} ],
"mustSupport": false,
"max": "1",
"label": "dayNumber",
"id": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions",
"min": 0,
"definition": "Specific instructions that apply to this administration on this day. eg for day 1 watch for anaphylaxis",
"short": "instructions",
"mapping": [ {
"map": "PlanDefinition.action.extension[timing-of-days].instructions",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "instructions",
"id": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication",
"min": 1,
"definition": "Details of the medication - including dosage and other details",
"short": "medication",
"mapping": [ {
"map": "PlanDefinition.action.definition[ActivityDefinition]",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "medication",
"id": "CancerRegimens.cycle.medicationAdministration.medication",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.offLabel",
"min": 0,
"definition": "Indicates that this usage of the medication is not one for which it has been specifically approved",
"short": "offLabel",
"mapping": [ {
"map": "ActivityDefinition.extension[off-label]",
"identity": "fhir"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"label": "offLabel",
"id": "CancerRegimens.cycle.medicationAdministration.medication.offLabel",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.offLabel"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.collection",
"min": 0,
"definition": "Where the medication is collected from prior to administration - eg a clinic or pharmacy (not a specific one - just the type of collection place)",
"short": "collection",
"mapping": [ {
"map": "ActivityDefinition.extension[location-medication-collection]",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "collection",
"id": "CancerRegimens.cycle.medicationAdministration.medication.collection",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.collection"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.location",
"min": 0,
"definition": "The physical location where the medication is to be administered - eg home, clinic",
"short": "location",
"mapping": [ {
"map": "ActivityDefinition.extension[location-administration]",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"max": "1",
"label": "location",
"id": "CancerRegimens.cycle.medicationAdministration.medication.location",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.location"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.code",
"min": 0,
"definition": "The code for the drug",
"short": "code",
"mapping": [ {
"map": "ActivityDefinition.productCodeableConcept",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "code",
"id": "CancerRegimens.cycle.medicationAdministration.medication.code",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.code"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose",
"min": 0,
"definition": "Dosage details for a single administration of the medication",
"short": "dose",
"mapping": [ {
"map": "ActivityDefinition.dosage",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"label": "dose",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.quantity",
"min": 0,
"definition": "Amount of medication to be administered at a time",
"short": "quantity",
"mapping": [ {
"map": "ActivityDefinition.dosage.doseAndRate.doseQuantity",
"identity": "fhir"
} ],
"type": [ {
"code": "Quantity"
} ],
"mustSupport": false,
"max": "1",
"label": "quantity",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.quantity",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.quantity"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.administrationRate",
"min": 0,
"definition": "The time in minutes over which the medication is to be administered (if an infusion). The first number is the minimum period that the infusion should be over.",
"short": "administratrionPeriod",
"mapping": [ {
"map": "ActivityDefinition.dosage.doseAndRate.rateRange",
"identity": "fhir"
} ],
"type": [ {
"code": "Range"
} ],
"mustSupport": false,
"max": "1",
"label": "administrationRate",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.administrationRate",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.administrationRate"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.route",
"min": 0,
"definition": "Route of administration",
"short": "route",
"mapping": [ {
"map": "ActivityDefinition.dosage.route",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "route",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.route",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.route"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay",
"min": 0,
"definition": "How many times per day that the medication should be administered if more than one",
"short": "timesPerDay",
"mapping": [ {
"map": "ActivityDefinition.dosage.timing.code",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "timesPerDay",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay"
}
} ]
},
"status": "draft",
"id": "9c539ce0-9c6c-4b9a-9ca3-e0db69e6468f",
"kind": "logical",
"url": "http://hl7.org.nz/fhir/cca/StructureDefinition/CancerRegimensLM",
"version": "0.1.0",
"differential": {
"element": [ {
"id": "CancerRegimens",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens"
},
"path": "CancerRegimens",
"definition": "No description"
}, {
"path": "CancerRegimens.status",
"min": 0,
"definition": "The overall status for the regimen. Includes that the regimen is approved for use (status=active) but is still under review so may change.",
"short": "status",
"mapping": [ {
"map": "PlanDefinition.status \nThere is an extension (regimen-under-review) on status that indicates that the regimen is under review. The actual status value will be 'active'.",
"identity": "fhir"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"max": "1",
"label": "status",
"id": "CancerRegimens.status",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.status"
}
}, {
"path": "CancerRegimens.version",
"min": 0,
"definition": "The version of the regimen",
"short": "version",
"mapping": [ {
"map": "PlanDefinition.version \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "version",
"id": "CancerRegimens.version",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.version"
}
}, {
"path": "CancerRegimens.title",
"min": 0,
"definition": "A short title that describes the regimen, suitable for a display",
"short": "title",
"mapping": [ {
"map": "PlanDefinition.title \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "title",
"id": "CancerRegimens.title",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.title"
}
}, {
"path": "CancerRegimens.description",
"min": 0,
"definition": "A more detailed description",
"short": "description",
"mapping": [ {
"map": "PlanDefinition.description \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "description",
"id": "CancerRegimens.description",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.description"
}
}, {
"path": "CancerRegimens.instructions",
"min": 0,
"definition": "Overall instructions for use. Distinct from the description of the regimen",
"short": "instructions",
"mapping": [ {
"map": "PlanDefinition.extension[plan-instructions] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "instructions",
"id": "CancerRegimens.instructions",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.instructions"
}
}, {
"path": "CancerRegimens.publisher",
"min": 0,
"definition": "The organisation responsible for publishing the regimen",
"short": "publisher",
"mapping": [ {
"map": "PlanDefinition.publisher \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "publisher",
"id": "CancerRegimens.publisher",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.publisher"
}
}, {
"path": "CancerRegimens.date",
"min": 0,
"definition": "When the regimen was first made available for use",
"short": "date",
"mapping": [ {
"map": "PlanDefinition.date \n",
"identity": "fhir"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"label": "date",
"id": "CancerRegimens.date",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.date"
}
}, {
"path": "CancerRegimens.type",
"min": 0,
"definition": "The type od regimen - eg FOLFOX",
"short": "type",
"mapping": [ {
"map": "PlanDefinition.extension[regimenType] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "type",
"id": "CancerRegimens.type",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.type"
}
}, {
"path": "CancerRegimens.intent",
"min": 0,
"definition": "The intent of the regimen - eg curative or palliative",
"short": "intent",
"mapping": [ {
"map": "PlanDefinition.extension[treatment-intent] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "intent",
"id": "CancerRegimens.intent",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.intent"
}
}, {
"path": "CancerRegimens.replacedBy",
"min": 0,
"definition": "populated if this regimen is no longer active, but has been replaced by another. Refers directly to the replacement regimen. Note that there is not a reference from the replacement regimen back to this one.",
"short": "replacedBy",
"mapping": [ {
"map": "PlanDefinition.extension[replaced-by] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "replacedBy",
"id": "CancerRegimens.replacedBy",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.replacedBy"
}
}, {
"path": "CancerRegimens.cancerTypes",
"min": 0,
"definition": "The types of cancer that this regimen is intended to treat. There can be up to 3 - type, subType, subSubType.",
"short": "CancerTypes",
"mapping": [ {
"map": "PlanDefinition.useContext.valueCodeableConcept \nPlanDefinition.useContext.code = \"focus\". Primary, subtype and subsubtype are in order.",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"label": "cancerTypes",
"id": "CancerRegimens.cancerTypes",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes"
}
}, {
"path": "CancerRegimens.cancerTypes.primaryType",
"min": 0,
"definition": "The main cancer that the regimen is targeted to. This will be the first one in the list and will always be present.",
"short": "primaryType",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "primaryType",
"id": "CancerRegimens.cancerTypes.primaryType",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes.primaryType"
}
}, {
"path": "CancerRegimens.cancerTypes.subType",
"min": 0,
"definition": "The cancer sub-type. Will be second in the list, if present.",
"short": "subType",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "subType",
"id": "CancerRegimens.cancerTypes.subType",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes.subType"
}
}, {
"path": "CancerRegimens.cancerTypes.subSubType",
"min": 0,
"definition": "The cancer sub-sub-type. Will be third in the list, if present.",
"short": "subSubType",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "subSubType",
"id": "CancerRegimens.cancerTypes.subSubType",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cancerTypes.subSubType"
}
}, {
"path": "CancerRegimens.supportFactor",
"min": 0,
"definition": "Factors - such as medications - that may be needed by the patient during a course of treatment - often to counter side-effects of treatment.",
"short": "supportFactor",
"mapping": [ {
"map": "PlanDefinition.extension[support-factor] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "supportFactor",
"id": "CancerRegimens.supportFactor",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.supportFactor"
}
}, {
"path": "CancerRegimens.supportFactor.type",
"min": 0,
"definition": "The type of sub-factor - eg anti-emetic",
"short": "type",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "type",
"id": "CancerRegimens.supportFactor.type",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.supportFactor.type"
}
}, {
"path": "CancerRegimens.supportFactor.value",
"min": 0,
"definition": "The actual factor - eg a specific anti-emetic",
"short": "value",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "value",
"id": "CancerRegimens.supportFactor.value",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.supportFactor.value"
}
}, {
"path": "CancerRegimens.disclaimer",
"min": 0,
"definition": "Important notes about the regimen to a potential user",
"short": "disclaimer",
"mapping": [ {
"map": "PlanDefinition.extension[disclaimer] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "disclaimer",
"id": "CancerRegimens.disclaimer",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.disclaimer"
}
}, {
"path": "CancerRegimens.references",
"min": 0,
"definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"short": "relatedArtifact",
"mapping": [ {
"map": "PlanDefinition.relatedArtifact \n",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "references",
"id": "CancerRegimens.references",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references"
}
}, {
"path": "CancerRegimens.references.type",
"min": 0,
"definition": "The type of related artifact",
"short": "type",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"label": "type",
"id": "CancerRegimens.references.type",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references.type"
}
}, {
"path": "CancerRegimens.references.display",
"min": 0,
"definition": "A string suitable for display",
"short": "display",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "display",
"id": "CancerRegimens.references.display",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references.display"
}
}, {
"path": "CancerRegimens.references.url",
"min": 0,
"definition": "The location where the artefact can be retrieved from",
"short": "url",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"label": "url",
"id": "CancerRegimens.references.url",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.references.url"
}
}, {
"path": "CancerRegimens.cycle",
"min": 1,
"definition": "Represents a single cycle of treatment. Note that in the FHIR resource, the cycle is nested...",
"short": "cycle",
"mapping": [ {
"map": "PlanDefinition.action \n",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "cycle",
"id": "CancerRegimens.cycle",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle"
}
}, {
"path": "CancerRegimens.cycle.description",
"min": 0,
"definition": "A human readable description of what the cycle is. eg \"Cabergoline administration, 2mg over 20 minutes\" repeated weekly for 4 weeks",
"short": "description",
"mapping": [ {
"map": "PlanDefinition.action.description \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "description",
"id": "CancerRegimens.cycle.description",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.description"
}
}, {
"path": "CancerRegimens.cycle.instructions",
"min": 0,
"definition": "Specific instructions for use during this cycle (as opposed to a description OF the cycle)",
"short": "instructions",
"mapping": [ {
"map": "PlanDefinition.action.extension[plan-instructions] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "instructions",
"id": "CancerRegimens.cycle.instructions",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.instructions"
}
}, {
"path": "CancerRegimens.cycle.duration",
"min": 0,
"definition": "The length of the cycle in days",
"short": "duration",
"mapping": [ {
"map": "PlanDefinition.action.timingTiming \n",
"identity": "fhir"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "1",
"label": "duration",
"id": "CancerRegimens.cycle.duration",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.duration"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration",
"min": 1,
"definition": "The details of medication administration within this cycle. Details of the administration are in the medication element.",
"short": "medication",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "medicationAdministration",
"id": "CancerRegimens.cycle.medicationAdministration",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.description",
"min": 0,
"definition": "Human description of the medication",
"short": "description",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "description",
"id": "CancerRegimens.cycle.medicationAdministration.description",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.description"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin",
"min": 0,
"definition": "Describes the days within the cycle that the medication is given.",
"short": "dailyAdmin",
"mapping": [ {
"map": "PlanDefinition.action.extension[timing-of-days] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"label": "dailyAdmin",
"id": "CancerRegimens.cycle.medicationAdministration.dailyAdmin",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber",
"min": 0,
"definition": "The day number for the administration from the start of the cycle",
"short": "dayNumber",
"mapping": [ {
"map": "PlanDefinition.action.extension[timing-of-days].day \n",
"identity": "fhir"
} ],
"type": [ {
"code": "integer"
} ],
"mustSupport": false,
"max": "1",
"label": "dayNumber",
"id": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions",
"min": 0,
"definition": "Specific instructions that apply to this administration on this day. eg for day 1 watch for anaphylaxis",
"short": "instructions",
"mapping": [ {
"map": "PlanDefinition.action.extension[timing-of-days].instructions \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"label": "instructions",
"id": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication",
"min": 1,
"definition": "Details of the medication - including dosage and other details",
"short": "medication",
"mapping": [ {
"map": "PlanDefinition.action.definition[ActivityDefinition] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "medication",
"id": "CancerRegimens.cycle.medicationAdministration.medication",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.offLabel",
"min": 0,
"definition": "Indicates that this usage of the medication is not one for which it has been specifically approved",
"short": "offLabel",
"mapping": [ {
"map": "ActivityDefinition.extension[off-label] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"label": "offLabel",
"id": "CancerRegimens.cycle.medicationAdministration.medication.offLabel",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.offLabel"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.collection",
"min": 0,
"definition": "Where the medication is collected from prior to administration - eg a clinic or pharmacy (not a specific one - just the type of collection place)",
"short": "collection",
"mapping": [ {
"map": "ActivityDefinition.extension[location-medication-collection] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "collection",
"id": "CancerRegimens.cycle.medicationAdministration.medication.collection",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.collection"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.location",
"min": 0,
"definition": "The physical location where the medication is to be administered - eg home, clinic",
"short": "location",
"mapping": [ {
"map": "ActivityDefinition.extension[location-administration] \n",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"max": "1",
"label": "location",
"id": "CancerRegimens.cycle.medicationAdministration.medication.location",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.location"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.code",
"min": 0,
"definition": "The code for the drug",
"short": "code",
"mapping": [ {
"map": "ActivityDefinition.productCodeableConcept \n",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "code",
"id": "CancerRegimens.cycle.medicationAdministration.medication.code",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.code"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose",
"min": 0,
"definition": "Dosage details for a single administration of the medication",
"short": "dose",
"mapping": [ {
"map": "ActivityDefinition.dosage \n",
"identity": "fhir"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"label": "dose",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.quantity",
"min": 0,
"definition": "Amount of medication to be administered at a time",
"short": "quantity",
"mapping": [ {
"map": "ActivityDefinition.dosage.doseAndRate.doseQuantity \n",
"identity": "fhir"
} ],
"type": [ {
"code": "Quantity"
} ],
"mustSupport": false,
"max": "1",
"label": "quantity",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.quantity",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.quantity"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.administrationRate",
"min": 0,
"definition": "The time in minutes over which the medication is to be administered (if an infusion). The first number is the minimum period that the infusion should be over.",
"short": "administratrionPeriod",
"mapping": [ {
"map": "ActivityDefinition.dosage.doseAndRate.rateRange \n",
"identity": "fhir"
} ],
"type": [ {
"code": "Range"
} ],
"mustSupport": false,
"max": "1",
"label": "administrationRate",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.administrationRate",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.administrationRate"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.route",
"min": 0,
"definition": "Route of administration",
"short": "route",
"mapping": [ {
"map": "ActivityDefinition.dosage.route \n",
"identity": "fhir"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"label": "route",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.route",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.route"
}
}, {
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay",
"min": 0,
"definition": "How many times per day that the medication should be administered if more than one",
"short": "timesPerDay",
"mapping": [ {
"map": "ActivityDefinition.dosage.timing.code \n",
"identity": "fhir"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"label": "timesPerDay",
"id": "CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay",
"base": {
"max": "1",
"min": 0,
"path": "CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay"
}
} ]
},
"contact": [ {
"name": "David Hay",
"telecom": [ {
"value": "mailto:david.hay25@gmail.com",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element"
}