FHIR IG Statistics: StructureDefinition/oncology-BreastSpecimen-model
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
BC BreastSpecimen Logical Model
Specimen resulting from biopsy or excision of breast and surrounding tissue.
Source
{
"resourceType": "StructureDefinition",
"id": "oncology-BreastSpecimen-model",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen-model",
"identifier": [
{
"system": "http://hl7.org/fhir/us/breastcancer",
"value": "oncology.BreastSpecimen"
}
],
"version": "0.2.0",
"name": "BreastSpecimenModel",
"title": "BC BreastSpecimen Logical Model",
"status": "draft",
"date": "2018-08-17T00:00:00+10:00",
"publisher": "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/cic/index.cfm"
}
]
}
],
"description": "Specimen resulting from biopsy or excision of breast and surrounding tissue.",
"kind": "logical",
"abstract": false,
"type": "oncology-BreastSpecimen-model",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "oncology-BreastSpecimen-model",
"path": "oncology-BreastSpecimen-model",
"definition": "Specimen resulting from biopsy or excision of breast and surrounding tissue.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model",
"min": 0,
"max": "*"
},
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.accessionIdentifier",
"path": "oncology-BreastSpecimen-model.accessionIdentifier",
"short": "Identifier assigned by the lab",
"definition": "Identifier assigned by the lab",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.accessionIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-AccessionIdentifier-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specimenStatus",
"path": "oncology-BreastSpecimen-model.specimenStatus",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C0449438"
}
],
"short": "State of the specimen, such as obtained, processed, used.",
"definition": "State of the specimen, such as obtained, processed, used.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.specimenStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-status"
}
}
},
{
"id": "oncology-BreastSpecimen-model.type",
"path": "oncology-BreastSpecimen-model.type",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C0332307"
}
],
"short": "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
"definition": "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
"min": 1,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenTypeVS"
}
}
},
{
"id": "oncology-BreastSpecimen-model.collectionSource",
"path": "oncology-BreastSpecimen-model.collectionSource",
"short": "The person or thing the sample was obtained from.",
"definition": "The person or thing the sample was obtained from.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionSource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Patient-model"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Group-model"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Device-model"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Substance-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.collectionTime",
"path": "oncology-BreastSpecimen-model.collectionTime",
"short": "When the sample was obtained, as a specific time or time period.",
"definition": "When the sample was obtained, as a specific time or time period.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
},
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.collectionMethod",
"path": "oncology-BreastSpecimen-model.collectionMethod",
"short": "How the specimen was obtained.",
"definition": "How the specimen was obtained.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionMethod",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenCollectionMethodVS"
}
}
},
{
"id": "oncology-BreastSpecimen-model.collectionSite",
"path": "oncology-BreastSpecimen-model.collectionSite",
"short": "The body site where specimen was collected",
"definition": "The body site where specimen was collected",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionSite",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSite-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.sourceSpecimen",
"path": "oncology-BreastSpecimen-model.sourceSpecimen",
"short": "Identifier for the source specimen from which this specimen was derived.",
"definition": "Identifier for the source specimen from which this specimen was derived.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.sourceSpecimen",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.receivedTime",
"path": "oncology-BreastSpecimen-model.receivedTime",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C2735124"
}
],
"short": "Time the item was delivered to, or accepted by, the receiving facility or unit.",
"definition": "Time the item was delivered to, or accepted by, the receiving facility or unit.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.receivedTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specimenContainer",
"path": "oncology-BreastSpecimen-model.specimenContainer",
"short": "Direct container of specimen (tube/slide, etc.)",
"definition": "Direct container of specimen (tube/slide, etc.)",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.specimenContainer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenContainer-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specimenTreatment",
"path": "oncology-BreastSpecimen-model.specimenTreatment",
"short": "Treatment performed on the specimen.",
"definition": "Treatment performed on the specimen.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.specimenTreatment",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenTreatment-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.handlingRisk",
"path": "oncology-BreastSpecimen-model.handlingRisk",
"short": "Cautions on the handling of this specimen.",
"definition": "Cautions on the handling of this specimen.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.handlingRisk",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specialHandling",
"path": "oncology-BreastSpecimen-model.specialHandling",
"short": "Information about the proper handling of the specimen.",
"definition": "Information about the proper handling of the specimen.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.specialHandling",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.tumorIdentifier",
"path": "oncology-BreastSpecimen-model.tumorIdentifier",
"short": "A human-readable identifier for the lesion; e.g., a letter or integer.",
"definition": "A human-readable identifier for the lesion; e.g., a letter or integer.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.tumorIdentifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.coldIschemiaTime",
"path": "oncology-BreastSpecimen-model.coldIschemiaTime",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C1948053"
},
{
"system": "http://loinc.org",
"code": "44778-9",
"display": "Cold ischemic time {Organ}"
}
],
"short": "The time period between the chilling of a tissue or tissue sample and the time it is warmed.",
"definition": "The time period between the chilling of a tissue or tissue sample and the time it is warmed.\nCIMI Alignment: In CIMI Version 0.0.4, specimen processing is represented as a 'SpecimenProcessingPerformed' clinical statement, mapped to FHIR Procedure. However, specimen processing maps to FHIR Specimen.processing, part of the Specimen resource. It would be a difficult mapping exercise (and beyond the scope of this IG) to express the mapping rule that any CIMI SpecimenProcessingPerformed clinical statement needs to mapped to FHIR by (1) finding the corresponding Specimen entity, and (2) mapping the content of (possibly multiple) SpecimenProcessingPerformed into the FHIR Specimen resource. To avoid this complexity, the breast cancer model expresses the cold ischemia time as an attribute of the BreastSpecimen rather than a separate procedure.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.coldIschemiaTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
}
]
},
"differential": {
"element": [
{
"id": "oncology-BreastSpecimen-model",
"path": "oncology-BreastSpecimen-model",
"definition": "Specimen resulting from biopsy or excision of breast and surrounding tissue.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model",
"min": 0,
"max": "*"
},
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.accessionIdentifier",
"path": "oncology-BreastSpecimen-model.accessionIdentifier",
"short": "Identifier assigned by the lab",
"definition": "Identifier assigned by the lab",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.accessionIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-AccessionIdentifier-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specimenStatus",
"path": "oncology-BreastSpecimen-model.specimenStatus",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C0449438"
}
],
"short": "State of the specimen, such as obtained, processed, used.",
"definition": "State of the specimen, such as obtained, processed, used.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.specimenStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-status"
}
}
},
{
"id": "oncology-BreastSpecimen-model.type",
"path": "oncology-BreastSpecimen-model.type",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C0332307"
}
],
"short": "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
"definition": "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
"min": 1,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenTypeVS"
}
}
},
{
"id": "oncology-BreastSpecimen-model.collectionSource",
"path": "oncology-BreastSpecimen-model.collectionSource",
"short": "The person or thing the sample was obtained from.",
"definition": "The person or thing the sample was obtained from.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionSource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Patient-model"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Group-model"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Device-model"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Substance-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.collectionTime",
"path": "oncology-BreastSpecimen-model.collectionTime",
"short": "When the sample was obtained, as a specific time or time period.",
"definition": "When the sample was obtained, as a specific time or time period.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
},
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.collectionMethod",
"path": "oncology-BreastSpecimen-model.collectionMethod",
"short": "How the specimen was obtained.",
"definition": "How the specimen was obtained.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionMethod",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenCollectionMethodVS"
}
}
},
{
"id": "oncology-BreastSpecimen-model.collectionSite",
"path": "oncology-BreastSpecimen-model.collectionSite",
"short": "The body site where specimen was collected",
"definition": "The body site where specimen was collected",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.collectionSite",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSite-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.sourceSpecimen",
"path": "oncology-BreastSpecimen-model.sourceSpecimen",
"short": "Identifier for the source specimen from which this specimen was derived.",
"definition": "Identifier for the source specimen from which this specimen was derived.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.sourceSpecimen",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.receivedTime",
"path": "oncology-BreastSpecimen-model.receivedTime",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C2735124"
}
],
"short": "Time the item was delivered to, or accepted by, the receiving facility or unit.",
"definition": "Time the item was delivered to, or accepted by, the receiving facility or unit.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.receivedTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specimenContainer",
"path": "oncology-BreastSpecimen-model.specimenContainer",
"short": "Direct container of specimen (tube/slide, etc.)",
"definition": "Direct container of specimen (tube/slide, etc.)",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.specimenContainer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenContainer-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specimenTreatment",
"path": "oncology-BreastSpecimen-model.specimenTreatment",
"short": "Treatment performed on the specimen.",
"definition": "Treatment performed on the specimen.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.specimenTreatment",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenTreatment-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.handlingRisk",
"path": "oncology-BreastSpecimen-model.handlingRisk",
"short": "Cautions on the handling of this specimen.",
"definition": "Cautions on the handling of this specimen.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.handlingRisk",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.specialHandling",
"path": "oncology-BreastSpecimen-model.specialHandling",
"short": "Information about the proper handling of the specimen.",
"definition": "Information about the proper handling of the specimen.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.specialHandling",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.tumorIdentifier",
"path": "oncology-BreastSpecimen-model.tumorIdentifier",
"short": "A human-readable identifier for the lesion; e.g., a letter or integer.",
"definition": "A human-readable identifier for the lesion; e.g., a letter or integer.",
"min": 0,
"max": "*",
"base": {
"path": "oncology-BreastSpecimen-model.tumorIdentifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "oncology-BreastSpecimen-model.coldIschemiaTime",
"path": "oncology-BreastSpecimen-model.coldIschemiaTime",
"code": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C1948053"
},
{
"system": "http://loinc.org",
"code": "44778-9",
"display": "Cold ischemic time {Organ}"
}
],
"short": "The time period between the chilling of a tissue or tissue sample and the time it is warmed.",
"definition": "The time period between the chilling of a tissue or tissue sample and the time it is warmed.\nCIMI Alignment: In CIMI Version 0.0.4, specimen processing is represented as a 'SpecimenProcessingPerformed' clinical statement, mapped to FHIR Procedure. However, specimen processing maps to FHIR Specimen.processing, part of the Specimen resource. It would be a difficult mapping exercise (and beyond the scope of this IG) to express the mapping rule that any CIMI SpecimenProcessingPerformed clinical statement needs to mapped to FHIR by (1) finding the corresponding Specimen entity, and (2) mapping the content of (possibly multiple) SpecimenProcessingPerformed into the FHIR Specimen resource. To avoid this complexity, the breast cancer model expresses the cold ischemia time as an attribute of the BreastSpecimen rather than a separate procedure.",
"min": 0,
"max": "1",
"base": {
"path": "oncology-BreastSpecimen-model.coldIschemiaTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
}
]
}
}
FHIR