{
"description": null,
"_filename": "StructureDefinition-qicore-specimen.json",
"package_name": "hl7.fhir.us.qicore",
"date": "2015-02-27",
"derivation": "constraint",
"publisher": "Health Level Seven International (Clinical Quality Information - QICore)",
"name": "Profile qicore-specimen",
"mapping": [ {
"uri": "http://www.hl7.org/implement/standards/product_brief.cfm?product_id=378",
"name": "Quality Improvement Domain Analysis Model",
"identity": "qidam"
}, {
"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": null,
"package_version": "1.6.0",
"snapshot": {
"element": [ {
"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)",
"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)",
"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))",
"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))]))",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Specimen",
"min": 0,
"definition": "A sample to be used for analysis.",
"short": "Sample for analysis",
"name": "QICore-Specimen",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Role[classCode=SPEC]",
"identity": "rim"
}, {
"map": "clinical.diagnostics",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "Specimen:qicore-specimen",
"base": {
"max": "*",
"min": 0,
"path": "Specimen"
},
"isSummary": false
}, {
"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",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Specimen:qicore-specimen.id",
"base": {
"max": "*",
"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:qicore-specimen.meta",
"base": {
"max": "*",
"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",
"comments": "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 as much as possible.",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Specimen:qicore-specimen.implicitRules",
"base": {
"max": "*",
"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",
"comments": "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).",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.language",
"base": {
"max": "*",
"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",
"comments": "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.",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Specimen:qicore-specimen.text",
"condition": [ "dom-1" ],
"base": {
"max": "*",
"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",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Specimen:qicore-specimen.contained",
"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",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:qicore-specimen.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"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",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:qicore-specimen.modifierExtension",
"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:qicore-specimen.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.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:qicore-specimen.accessionIdentifier",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.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",
"description": "Codes providing the status/availability of a specimen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-status"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.status",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.status"
},
"isSummary": true
}, {
"path": "Specimen.type",
"min": 0,
"definition": "The kind of material that forms the specimen.",
"short": "Kind of material that forms the specimen",
"comments": "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.",
"mapping": [ {
"map": "SPM-4 and possibly SPM-5",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"description": "The type of the specimen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0487"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.type",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.type"
},
"isSummary": false
}, {
"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",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-device"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-substance"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"mustSupport": true,
"max": "1",
"id": "Specimen:qicore-specimen.subject",
"base": {
"max": "1",
"min": 1,
"path": "Specimen.subject"
},
"isSummary": false
}, {
"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"
} ],
"mustSupport": true,
"max": "1",
"id": "Specimen:qicore-specimen.receivedTime",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.receivedTime"
},
"isSummary": false
}, {
"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",
"comments": "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.",
"mapping": [ {
"map": ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-specimen"
} ],
"mustSupport": false,
"max": "*",
"id": "Specimen:qicore-specimen.parent",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.parent"
},
"isSummary": false
}, {
"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",
"comments": "The request may be explicit or implied such with a DiagnosticRequest that requires a blood draw.",
"mapping": [ {
"map": "ORC? OBR-2/3?",
"identity": "v2"
}, {
"map": "outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticRequest"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
} ],
"max": "*",
"id": "Specimen:qicore-specimen.request",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.request"
}
}, {
"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"
} ],
"mustSupport": false,
"max": "1",
"id": "Specimen:qicore-specimen.collection",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection"
},
"isSummary": false
}, {
"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:qicore-specimen.collection.id",
"base": {
"max": "*",
"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",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:qicore-specimen.collection.extension",
"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",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen:qicore-specimen.collection.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Specimen.collection.collector",
"min": 0,
"definition": "A person who is directly or indirectly involved in the provisioning of healthcare.",
"short": "A person with a formal responsibility in the provisioning of healthcare or related services",
"comments": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "PRD (as one example)",
"identity": "v2"
}, {
"map": "Role",
"identity": "rim"
}, {
"map": "Provider",
"identity": "servd"
}, {
"map": "administrative.individual",
"identity": "w5"
}, {
"map": "Provider Characteristic",
"identity": "qdm"
} ],
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-practitioner"
} ],
"mustSupport": false,
"max": "1",
"id": "Specimen:qicore-specimen.collection.collector",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.collector"
},
"isSummary": false
}, {
"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"
} ],
"mustSupport": true,
"max": "1",
"id": "Specimen:qicore-specimen.collection.collected[x]",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.collected[x]"
},
"isSummary": false
}, {
"path": "Specimen.collection.quantity",
"min": 0,
"definition": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.",
"short": "The quantity of specimen collected",
"mapping": [ {
"map": "SPM-12",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"max": "1",
"id": "Specimen:qicore-specimen.collection.quantity",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.quantity"
}
}, {
"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": "example",
"description": "The technique that is used to perform the procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-collection-method"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.collection.method",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.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",
"comments": "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).",
"mapping": [ {
"map": "SPM-8 and SPM-9",
"identity": "v2"
}, {
"map": ".targetSiteCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/body-site"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.collection.bodySite",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.bodySite"
},
"isSummary": false
}, {
"path": "Specimen.treatment",
"min": 0,
"definition": "Details concerning treatment and processing steps for the specimen.",
"short": "Treatment and processing step details",
"mapping": [ {
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Specimen:qicore-specimen.treatment",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.treatment"
},
"isSummary": false
}, {
"path": "Specimen.treatment.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:qicore-specimen.treatment.id",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Specimen.treatment.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",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen:qicore-specimen.treatment.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Specimen.treatment.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",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen:qicore-specimen.treatment.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Specimen.treatment.description",
"min": 0,
"definition": "Textual description of procedure.",
"short": "Textual description of procedure",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Specimen:qicore-specimen.treatment.description",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.treatment.description"
}
}, {
"path": "Specimen.treatment.procedure",
"min": 0,
"definition": "A coded value specifying the procedure used to process the specimen.",
"short": "Indicates the treatment or processing step applied to the specimen",
"mapping": [ {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"description": "Type indicating the technique used to process the specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-treatment-procedure"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.treatment.procedure",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.treatment.procedure"
},
"isSummary": false
}, {
"path": "Specimen.treatment.additive",
"min": 0,
"definition": "Material used in the processing step.",
"short": "Material used in the processing step",
"mapping": [ {
"map": "SPM-6",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-substance"
} ],
"mustSupport": false,
"max": "*",
"id": "Specimen:qicore-specimen.treatment.additive",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.treatment.additive"
},
"isSummary": false
}, {
"id": "Specimen:qicore-specimen.treatment.time[x]",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Specimen.treatment.time[x]"
},
"path": "Specimen.treatment.time[x]",
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"short": "Date and time of specimen treatment",
"definition": "A record of the time or period when the specimen treatment occurred. For example the time of sample fixation or the period of time the sample was in formalin."
}, {
"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"
} ],
"mustSupport": false,
"max": "*",
"id": "Specimen:qicore-specimen.container",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.container"
},
"isSummary": false
}, {
"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:qicore-specimen.container.id",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.container.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"name": "Specimen.container.sequenceNumber",
"mapping": [ {
"map": "Not in QIDAM, but recognized as important since there are labs where the sequence of the collection is important (e.g., knowing that 1 is the first sample, 2 is the second, etc.).",
"identity": "qidam"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber"
} ],
"mustSupport": false,
"max": "1",
"id": "Specimen:qicore-specimen.container.extension:specimencontainersequencenumber$specimen-sequenceNumber",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"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",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen:qicore-specimen.container.modifierExtension",
"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:qicore-specimen.container.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.container.identifier"
},
"isSummary": true
}, {
"path": "Specimen.container.description",
"min": 0,
"definition": "Textual description of the container.",
"short": "Textual description of the container",
"mapping": [ {
"map": ".desc",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Specimen:qicore-specimen.container.description",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.description"
}
}, {
"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",
"description": "Type of specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.container.type",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.type"
}
}, {
"path": "Specimen.container.capacity",
"min": 0,
"definition": "The capacity (volume or other measure) the container may contain.",
"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"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"max": "1",
"id": "Specimen:qicore-specimen.container.capacity",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.capacity"
}
}, {
"path": "Specimen.container.specimenQuantity",
"min": 0,
"definition": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"short": "Quantity of specimen within container",
"mapping": [ {
"map": "SAC-23 (value) SAC-24 (units",
"identity": "v2"
}, {
"map": ".playedRole[classCode=CONT].quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"max": "1",
"id": "Specimen:qicore-specimen.container.specimenQuantity",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.specimenQuantity"
}
}, {
"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",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-substance"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"description": "Substance added to specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0371"
}
},
"max": "1",
"id": "Specimen:qicore-specimen.container.additive[x]",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.additive[x]"
},
"isSummary": false
}, {
"path": "Specimen.note",
"min": 0,
"definition": "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).",
"short": "Comments",
"mapping": [ {
"map": "OBX",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "Specimen:qicore-specimen.note",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.note"
}
} ]
},
"status": "draft",
"id": "2942c3e5-c058-438c-b1ae-c0ba9d3d513a",
"kind": "resource",
"url": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-specimen",
"version": null,
"differential": {
"element": [ {
"id": "Specimen:qicore-specimen",
"name": "QICore-Specimen",
"path": "Specimen",
"isSummary": false,
"isModifier": false,
"mustSupport": false
}, {
"id": "Specimen:qicore-specimen.type",
"path": "Specimen.type",
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "Specimen:qicore-specimen.subject",
"path": "Specimen.subject",
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-device"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-substance"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "Specimen:qicore-specimen.receivedTime",
"path": "Specimen.receivedTime",
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "Specimen:qicore-specimen.parent",
"path": "Specimen.parent",
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-specimen"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": false
}, {
"id": "Specimen:qicore-specimen.collection",
"path": "Specimen.collection",
"isSummary": false,
"isModifier": false,
"mustSupport": false
}, {
"id": "Specimen:qicore-specimen.collection.collector",
"path": "Specimen.collection.collector",
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-practitioner"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": false
}, {
"id": "Specimen:qicore-specimen.collection.collected[x]",
"path": "Specimen.collection.collected[x]",
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "Specimen:qicore-specimen.collection.bodySite",
"path": "Specimen.collection.bodySite",
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "Specimen:qicore-specimen.treatment",
"path": "Specimen.treatment",
"isSummary": false,
"isModifier": false,
"mustSupport": false
}, {
"id": "Specimen:qicore-specimen.treatment.procedure",
"path": "Specimen.treatment.procedure",
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "Specimen:qicore-specimen.treatment.additive",
"path": "Specimen.treatment.additive",
"type": [ {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-substance"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": false
}, {
"id": "Specimen:qicore-specimen.container",
"path": "Specimen.container",
"isSummary": false,
"isModifier": false,
"mustSupport": false
}, {
"path": "Specimen.container.extension",
"min": 0,
"isModifier": false,
"name": "Specimen.container.sequenceNumber",
"mapping": [ {
"map": "Not in QIDAM, but recognized as important since there are labs where the sequence of the collection is important (e.g., knowing that 1 is the first sample, 2 is the second, etc.).",
"identity": "qidam"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber"
} ],
"mustSupport": false,
"max": "1",
"id": "Specimen:qicore-specimen.container.extension:specimencontainersequencenumber$specimen-sequenceNumber",
"isSummary": false
}, {
"id": "Specimen:qicore-specimen.container.additive[x]",
"path": "Specimen.container.additive[x]",
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"profile": "http://hl7.org/fhir/qicore/StructureDefinition/qicore-substance"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/CQI",
"system": "other"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Specimen"
}