{
"description": "Specimen resulting from biopsy or excision of breast and surrounding tissue.",
"_filename": "StructureDefinition-oncology-BreastSpecimen.json",
"package_name": "hl7.fhir.us.breastcancer",
"date": "2018-04-01T00:00:00+11:00",
"derivation": "constraint",
"publisher": "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
"fhirVersion": "3.0.1",
"name": "BreastSpecimenProfile",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Specimen",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "BC BreastSpecimen Profile",
"package_version": "0.1.0",
"snapshot": {
"element": [ {
"id": "Specimen:oncology-BreastSpecimen",
"max": "*",
"min": 0,
"path": "Specimen",
"short": "BC BreastSpecimen Profile",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Role[classCode=SPEC]",
"identity": "rim"
}, {
"map": "clinical.diagnostics",
"identity": "w5"
} ],
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"definition": "Specimen resulting from biopsy or excision of breast and surrounding tissue."
}, {
"path": "Specimen.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Specimen.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Specimen.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Specimen.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Specimen.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Specimen.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Specimen.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"id": "3",
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.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": "DomainResource.extension"
}
}, {
"id": "Specimen:oncology-BreastSpecimen.extension:collectionsite",
"max": "1",
"min": 0,
"path": "Specimen.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/body-site-instance"
} ],
"sliceName": "collectionsite",
"definition": "The body site where specimen was collected"
}, {
"path": "Specimen.extension.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.extension:collectionsite.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Specimen.extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"sliceName": "extension",
"max": "0",
"id": "Specimen:oncology-BreastSpecimen.extension:collectionsite.extension:extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Specimen.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-CollectionSite-extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.extension:collectionsite.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Specimen.extension.valueReference",
"min": 1,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-AnatomicalLocation"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.extension:collectionsite.valueReference",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Specimen.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.modifierExtension",
"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": "DomainResource.modifierExtension"
}
}, {
"path": "Specimen.identifier",
"min": 0,
"definition": "Id for specimen.",
"short": "External Identifier",
"mapping": [ {
"map": "SPM-2",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.identifier",
"isSummary": true
}, {
"path": "Specimen.accessionIdentifier",
"min": 0,
"definition": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.",
"short": "Identifier assigned by the lab",
"mapping": [ {
"map": "SPM-30 (v2.7+)",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.accessionIdentifier",
"isSummary": true
}, {
"path": "Specimen.status",
"min": 0,
"definition": "The availability of the specimen.",
"isModifier": true,
"short": "available | unavailable | unsatisfactory | entered-in-error",
"mapping": [ {
"map": "SPM-20",
"identity": "v2"
}, {
"map": "status",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenStatus"
} ],
"description": "Codes providing the status/availability of a specimen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-status"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.status",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"isSummary": true
}, {
"path": "Specimen.type",
"min": 1,
"definition": "The kind of material that forms the specimen.",
"short": "Kind of material that forms the specimen",
"mapping": [ {
"map": "SPM-4 and possibly SPM-5",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenTypeVS"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.type",
"comment": "The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"isSummary": true
}, {
"path": "Specimen.subject",
"requirements": "Must know the subject context.",
"min": 1,
"definition": "Where the specimen came from. This may be from the patient(s) or from the environment or a device.",
"short": "Where the specimen came from. This may be from the patient(s) or from the environment or a device",
"mapping": [ {
"map": ".scoper or .scoper.playsRole",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.subject",
"isSummary": true
}, {
"path": "Specimen.receivedTime",
"min": 0,
"definition": "Time when specimen was received for processing or testing.",
"short": "The time when specimen was received for processing",
"mapping": [ {
"map": "SPM-18",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.receivedTime",
"isSummary": true
}, {
"path": "Specimen.parent",
"min": 0,
"definition": "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.",
"short": "Specimen from which this specimen originated",
"mapping": [ {
"map": ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.parent",
"comment": "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample."
}, {
"path": "Specimen.request",
"min": 0,
"definition": "Details concerning a test or procedure request that required a specimen to be collected.",
"short": "Why the specimen was collected",
"mapping": [ {
"map": "ORC? OBR-2/3?",
"identity": "v2"
}, {
"map": "outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
} ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.request",
"comment": "The request may be explicit or implied such with a ProcedureRequest that requires a blood draw."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Specimen.collection",
"min": 0,
"definition": "Details concerning the specimen collection.",
"short": "Collection details",
"mapping": [ {
"map": "SPM-14",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.collection"
}, {
"path": "Specimen.collection.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.collection.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Specimen.collection.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.collection.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"
}
}, {
"path": "Specimen.collection.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.collection.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Specimen.collection.collector",
"min": 0,
"definition": "Person who collected the specimen.",
"short": "Who collected the specimen",
"mapping": [ {
"map": "PRT",
"identity": "v2"
}, {
"map": ".participation[typeCode=PFM].role",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.collection.collector",
"isSummary": true
}, {
"path": "Specimen.collection.collected[x]",
"min": 0,
"definition": "Time when specimen was collected from subject - the physiologically relevant time.",
"short": "Collection time",
"mapping": [ {
"map": "SPM-17",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.collection.collected[x]",
"isSummary": true
}, {
"id": "Specimen:oncology-BreastSpecimen.collection.quantity",
"max": "1",
"min": 0,
"path": "Specimen.collection.quantity",
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"short": "The quantity of specimen collected",
"mapping": [ {
"map": "SPM-12",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity",
"identity": "rim"
} ],
"definition": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample."
}, {
"path": "Specimen.collection.method",
"min": 0,
"definition": "A coded value specifying the technique that is used to perform the procedure.",
"short": "Technique used to perform collection",
"mapping": [ {
"map": "SPM-7",
"identity": "v2"
}, {
"map": ".methodCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenCollectionMethodVS"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.collection.method"
}, {
"path": "Specimen.collection.bodySite",
"min": 0,
"definition": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.",
"short": "Anatomical collection site",
"mapping": [ {
"map": "SPM-8 and SPM-9",
"identity": "v2"
}, {
"map": ".targetSiteCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "Codes describing anatomical locations. May include laterality.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/body-site"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.collection.bodySite",
"comment": "If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html)."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Specimen.processing",
"min": 0,
"definition": "Details concerning processing and processing steps for the specimen.",
"short": "Processing and processing step details",
"mapping": [ {
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]",
"identity": "rim"
} ],
"slicing": {
"id": "1",
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "procedure",
"type": "value"
} ]
},
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.processing"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Specimen.processing",
"min": 0,
"definition": "The time period between the chilling of a tissue or tissue sample and the time it is warmed.\n\nCIMI Alignment: In CIMI Version 0.0.4, specimen processing is represented as a 'SpecimenProcessingPerformed' clinical statement, mapped to FHIR Procedure. However, specimen processing should actually map to Specimen.processing, part of the Specimen resource. It would be a difficult mapping exercise (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.",
"short": "ColdIschemiaTime",
"mapping": [ {
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"sliceName": "oncology-ColdIschemiaTime",
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime"
}, {
"path": "Specimen.processing.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Specimen.processing.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.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"
}
}, {
"path": "Specimen.processing.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.description",
"max": "1",
"min": 0,
"path": "Specimen.processing.description",
"type": [ {
"code": "string"
} ],
"short": "Textual description of procedure",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"definition": "Textual description of procedure."
}, {
"path": "Specimen.processing.procedure",
"min": 0,
"definition": "A coded value specifying the procedure used to process the specimen.",
"short": "Indicates the treatment step applied to the specimen",
"mapping": [ {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenProcessingProcedure"
} ],
"description": "Type indicating the technique used to process the specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-processing-procedure"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure"
}, {
"path": "Specimen.processing.procedure.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Specimen.processing.procedure.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.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"
}
}, {
"path": "Specimen.processing.procedure.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"id": "2",
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "code",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"isSummary": true
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9",
"max": "1",
"min": 1,
"path": "Specimen.processing.procedure.coding",
"type": [ {
"code": "Coding"
} ],
"isSummary": true,
"sliceName": "Fixed_44778-9",
"definition": "A reference to a code defined by a terminology system."
}, {
"path": "Specimen.processing.procedure.coding.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Specimen.processing.procedure.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.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"
}
}, {
"path": "Specimen.processing.procedure.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://loinc.org",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"isSummary": true
}, {
"path": "Specimen.processing.procedure.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"isSummary": true
}, {
"path": "Specimen.processing.procedure.coding.code",
"fixedCode": "44778-9",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.code",
"isSummary": true
}, {
"path": "Specimen.processing.procedure.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.display",
"isSummary": true
}, {
"path": "Specimen.processing.procedure.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"isSummary": true
}, {
"path": "Specimen.processing.procedure.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"isSummary": true
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.additive",
"max": "0",
"min": 0,
"path": "Specimen.processing.additive",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
} ],
"short": "Material used in the processing step",
"mapping": [ {
"map": "SPM-6",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code",
"identity": "rim"
} ],
"definition": "Material used in the processing step."
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.timePeriod",
"max": "1",
"min": 0,
"path": "Specimen.processing.timePeriod",
"type": [ {
"code": "Period"
} ],
"short": "Date and time of specimen processing",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Specimen.container",
"min": 0,
"definition": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.",
"short": "Direct container of specimen (tube/slide, etc.)",
"mapping": [ {
"map": ".player.scopingRole[classCode=CONT].scoper",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.container"
}, {
"path": "Specimen.container.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.container.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Specimen.container.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.container.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"
}
}, {
"path": "Specimen.container.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.container.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Specimen.container.identifier",
"min": 0,
"definition": "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.",
"short": "Id for the container",
"mapping": [ {
"map": "SAC-3",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Specimen:oncology-BreastSpecimen.container.identifier",
"isSummary": true
}, {
"id": "Specimen:oncology-BreastSpecimen.container.description",
"max": "1",
"min": 0,
"path": "Specimen.container.description",
"type": [ {
"code": "string"
} ],
"short": "Textual description of the container",
"mapping": [ {
"map": ".desc",
"identity": "rim"
} ],
"definition": "Textual description of the container."
}, {
"path": "Specimen.container.type",
"min": 0,
"definition": "The type of container associated with the specimen (e.g. slide, aliquot, etc.).",
"short": "Kind of container directly associated with specimen",
"mapping": [ {
"map": "SPM-27",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainerType"
} ],
"description": "Type of specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.container.type"
}, {
"id": "Specimen:oncology-BreastSpecimen.container.capacity",
"max": "1",
"min": 0,
"path": "Specimen.container.capacity",
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"short": "Container volume or size",
"mapping": [ {
"map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20",
"identity": "v2"
}, {
"map": ".quantity",
"identity": "rim"
} ],
"definition": "The capacity (volume or other measure) the container may contain."
}, {
"id": "Specimen:oncology-BreastSpecimen.container.specimenQuantity",
"max": "1",
"min": 0,
"path": "Specimen.container.specimenQuantity",
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"short": "Quantity of specimen within container",
"mapping": [ {
"map": "SAC-23 (value) SAC-24 (units",
"identity": "v2"
}, {
"map": ".playedRole[classCode=CONT].quantity",
"identity": "rim"
} ],
"definition": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type."
}, {
"path": "Specimen.container.additive[x]",
"min": 0,
"definition": "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"short": "Additive associated with container",
"mapping": [ {
"map": "SAC-27",
"identity": "v2"
}, {
"map": ".scopesRole[classCode=ADTV].player",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainerAdditive"
} ],
"description": "Substance added to specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0371"
}
},
"max": "1",
"id": "Specimen:oncology-BreastSpecimen.container.additive[x]"
}, {
"id": "Specimen:oncology-BreastSpecimen.note",
"max": "*",
"min": 0,
"path": "Specimen.note",
"type": [ {
"code": "Annotation"
} ],
"short": "Comments",
"mapping": [ {
"map": "OBX",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"definition": "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen)."
} ]
},
"status": "draft",
"id": "34f0f201-8de6-46cf-9e68-78b8540f86f3",
"kind": "resource",
"url": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen",
"identifier": [ {
"value": "oncology.BreastSpecimen",
"system": "http://hl7.org/fhir/us/breastcancer"
} ],
"version": "0.1.0",
"differential": {
"element": [ {
"id": "Specimen:oncology-BreastSpecimen",
"path": "Specimen",
"short": "BC BreastSpecimen Profile",
"definition": "Specimen resulting from biopsy or excision of breast and surrounding tissue."
}, {
"id": "Specimen:oncology-BreastSpecimen.extension:collectionsite",
"max": "1",
"min": 0,
"path": "Specimen.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/body-site-instance"
} ],
"sliceName": "collectionsite",
"definition": "The body site where specimen was collected"
}, {
"id": "Specimen:oncology-BreastSpecimen.type",
"max": "1",
"min": 1,
"path": "Specimen.type",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenTypeVS"
}
}
}, {
"id": "Specimen:oncology-BreastSpecimen.parent",
"max": "1",
"min": 0,
"path": "Specimen.parent",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen"
} ]
}, {
"id": "Specimen:oncology-BreastSpecimen.collection",
"path": "Specimen.collection"
}, {
"id": "Specimen:oncology-BreastSpecimen.collection.method",
"path": "Specimen.collection.method",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/breastcancer/ValueSet/oncology-BreastSpecimenCollectionMethodVS"
}
}
}, {
"id": "Specimen:oncology-BreastSpecimen.processing",
"path": "Specimen.processing",
"slicing": {
"id": "1",
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "procedure",
"type": "value"
} ]
}
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime",
"max": "1",
"min": 0,
"path": "Specimen.processing",
"short": "ColdIschemiaTime",
"sliceName": "oncology-ColdIschemiaTime",
"definition": "The time period between the chilling of a tissue or tissue sample and the time it is warmed.\n\nCIMI Alignment: In CIMI Version 0.0.4, specimen processing is represented as a 'SpecimenProcessingPerformed' clinical statement, mapped to FHIR Procedure. However, specimen processing should actually map to Specimen.processing, part of the Specimen resource. It would be a difficult mapping exercise (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."
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure",
"path": "Specimen.processing.procedure"
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding",
"path": "Specimen.processing.procedure.coding",
"slicing": {
"id": "2",
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "code",
"type": "value"
} ]
}
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9",
"max": "1",
"min": 1,
"path": "Specimen.processing.procedure.coding",
"type": [ {
"code": "Coding"
} ],
"isSummary": true,
"sliceName": "Fixed_44778-9",
"definition": "A reference to a code defined by a terminology system."
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.system",
"path": "Specimen.processing.procedure.coding.system",
"fixedUri": "http://loinc.org"
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.procedure.coding:Fixed_44778-9.code",
"path": "Specimen.processing.procedure.coding.code",
"fixedCode": "44778-9"
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.additive",
"max": "0",
"min": 0,
"path": "Specimen.processing.additive"
}, {
"id": "Specimen:oncology-BreastSpecimen.processing:oncology-ColdIschemiaTime.timePeriod",
"path": "Specimen.processing.timePeriod",
"type": [ {
"code": "Period"
} ]
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://standardhealthrecord.org",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Specimen"
}