{
"description": "Identification and description of a specimen sent by a Medical Examiner, Coroner, or autopsy performer to a toxicology lab for analysis. For specimens received but not analyzed, the laboratory should provide a reason for no analysis in the DiagnosticReport.conclusion and/or each unanalyzed specimen’s Specimen - Toxicology Lab Specimen.note. The laboratory may use the Specimen.condition to describe the state of the specimen via codes from the extensible value set hl7VS-specimenCondition and/or use the Specimen.note to describe details or issues about the specimen.",
"_filename": "StructureDefinition-Specimen-toxicology-lab.json",
"package_name": "hl7.fhir.us.mdi",
"date": "2025-03-28T22:13:34+11:00",
"derivation": "constraint",
"publisher": "HL7 International / Public Health",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "SpecimenToxicologyLab",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Specimen",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Specimen - Toxicology Lab",
"package_version": "2.0.0-snapshot2",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pher"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/mdi/ImplementationGuide/hl7.fhir.us.mdi"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/mdi/ImplementationGuide/hl7.fhir.us.mdi"
} ]
}
} ],
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "Specimen",
"min": 0,
"definition": "The specimen sent by a Medical Examiner, Coroner, or autopsy performer to a toxicology lab for analysis.",
"isModifier": false,
"short": "The specimen sent by a Medical Examiner, Coroner, or autopsy performer to a toxicology lab for analysis.",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Role[classCode=SPEC]",
"identity": "rim"
} ],
"max": "*",
"id": "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.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"max": "1",
"id": "Specimen.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Specimen.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Specimen.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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language."
},
"max": "1",
"id": "Specimen.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can 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.",
"isModifier": false,
"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.text",
"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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Specimen.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen.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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.identifier",
"min": 0,
"definition": "System-generated identifier for this Specimen.",
"isModifier": false,
"short": "System-generated identifier for this Specimen.",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "SPM-2",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Specimen.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "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.",
"isModifier": false,
"short": "Identifier assigned by the lab",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "SPM-30 (v2.7+)",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "1",
"id": "Specimen.accessionIdentifier",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.accessionIdentifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.status",
"min": 0,
"definition": "The availability of the specimen.",
"isModifier": true,
"short": "available | unavailable | unsatisfactory | entered-in-error",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "SPM-20",
"identity": "v2"
}, {
"map": "status",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenStatus"
} ],
"description": "Codes providing the status/availability of a specimen."
},
"max": "1",
"id": "Specimen.status",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.status"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.type",
"min": 1,
"definition": "Type of tissue or material (blood, etc.).",
"isModifier": false,
"short": "Type of tissue or material",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "SPM-4 and possibly SPM-5",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0487",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenType"
} ],
"description": "The type of the specimen."
},
"max": "1",
"id": "Specimen.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.",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.type"
},
"isSummary": true
}, {
"path": "Specimen.type.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen.type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.type.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen.type.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.type.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"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"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"max": "*",
"id": "Specimen.type.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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.type.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": 1,
"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.",
"isModifier": false,
"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"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Specimen.type.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.subject",
"requirements": "Must know the subject context.",
"min": 0,
"definition": "The subject is the decedent.",
"isModifier": false,
"short": "The subject is the decedent.",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": ".scoper or .scoper.playsRole",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Specimen.subject",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.subject"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.receivedTime",
"min": 0,
"definition": "Time when specimen was received for processing or testing.",
"isModifier": false,
"short": "Time when specimen was received by the forensic toxicology lab for processing",
"mapping": [ {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": "SPM-18",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"max": "1",
"label": "Time when specimen was received by the forensic toxicology lab for processing",
"id": "Specimen.receivedTime",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.receivedTime"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "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.",
"isModifier": false,
"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/mdi/StructureDefinition/Specimen-toxicology-lab" ]
} ],
"mustSupport": true,
"max": "*",
"id": "Specimen.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.",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.parent"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.request",
"min": 0,
"definition": "Details concerning a service request that required a specimen to be collected.",
"isModifier": false,
"short": "Why the specimen was collected",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "ORC? OBR-2/3?",
"identity": "v2"
}, {
"map": "outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ]
} ],
"max": "*",
"id": "Specimen.request",
"comment": "The request may be explicit or implied such with a ServiceRequest that requires a blood draw.",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.request"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.collection",
"min": 0,
"definition": "Details concerning the specimen collection.",
"isModifier": false,
"short": "Collection details",
"mapping": [ {
"map": "SPM-14",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"id": "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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen.collection.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.collection.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.collection.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen.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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.collection.collector",
"min": 0,
"definition": "Person who collected the specimen.",
"isModifier": false,
"short": "Who collected the specimen",
"mapping": [ {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "PRT",
"identity": "v2"
}, {
"map": ".participation[typeCode=PFM].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"max": "1",
"id": "Specimen.collection.collector",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.collector"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.collection.collected[x]",
"min": 0,
"definition": "Time when specimen was collected from subject - the physiologically relevant time.",
"isModifier": false,
"short": "Time collected from either the body or the scene",
"mapping": [ {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "SPM-17",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"label": "Time collected from either the body or the scene",
"id": "Specimen.collection.collected[x]",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.collected[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.collection.duration",
"min": 0,
"definition": "The span of time over which the collection of a specimen occurred.",
"isModifier": false,
"short": "How long it took to collect specimen",
"mapping": [ {
"map": "FiveWs.init",
"identity": "w5"
} ],
"type": [ {
"code": "Duration"
} ],
"max": "1",
"id": "Specimen.collection.duration",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.duration"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "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.",
"isModifier": false,
"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.collection.quantity",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.quantity"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.collection.method",
"min": 0,
"definition": "A coded value specifying the technique that is used to perform the procedure.",
"isModifier": false,
"short": "Technique used to perform collection",
"mapping": [ {
"map": "SPM-7",
"identity": "v2"
}, {
"map": ".methodCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-collection-method",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenCollectionMethod"
} ],
"description": "The technique that is used to perform the procedure."
},
"max": "1",
"id": "Specimen.collection.method",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.method"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Anatomical collection site",
"mapping": [ {
"map": "SPM-8 and SPM-9",
"identity": "v2"
}, {
"map": ".targetSiteCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/body-site",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "Codes describing anatomical locations. May include laterality."
},
"max": "1",
"id": "Specimen.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 [bodySite](http://hl7.org/fhir/R4/extension-bodysite.html).",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.bodySite"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.collection.fastingStatus[x]",
"requirements": "Many diagnostic tests require fasting to facilitate accurate interpretation.",
"min": 0,
"definition": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.",
"isModifier": false,
"short": "Whether or how long patient abstained from food and/or drink",
"mapping": [ {
"map": "OBR-",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Duration"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0916",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FastingStatus"
} ],
"description": "Codes describing the fasting status of the patient."
},
"max": "1",
"id": "Specimen.collection.fastingStatus[x]",
"comment": "Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/​time] in 2 hour Urine --12 hours fasting), or using a component observation ` such as `Observation.component code` = LOINC 49541-6 (Fasting status - Reported).",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.collection.fastingStatus[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.processing",
"min": 0,
"definition": "Details concerning processing and processing steps for the specimen.",
"isModifier": false,
"short": "Processing and processing step details",
"mapping": [ {
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "Specimen.processing",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.processing"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen.processing.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.processing.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen.processing.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.processing.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen.processing.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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.processing.description",
"min": 0,
"definition": "Textual description of procedure.",
"isModifier": false,
"short": "Textual description of procedure",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Specimen.processing.description",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.processing.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.processing.procedure",
"min": 0,
"definition": "A coded value specifying the procedure used to process the specimen.",
"isModifier": false,
"short": "Indicates the treatment step applied to the specimen",
"mapping": [ {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-processing-procedure",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenProcessingProcedure"
} ],
"description": "Type indicating the technique used to process the specimen."
},
"max": "1",
"id": "Specimen.processing.procedure",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.processing.procedure"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.processing.additive",
"min": 0,
"definition": "Material used in the processing step.",
"isModifier": false,
"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",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Substance" ]
} ],
"max": "*",
"id": "Specimen.processing.additive",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.processing.additive"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.processing.time[x]",
"min": 0,
"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.",
"isModifier": false,
"short": "Date and time of specimen processing",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"id": "Specimen.processing.time[x]",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.processing.time[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Direct container of specimen (tube/slide, etc.)",
"mapping": [ {
"map": ".player.scopingRole[classCode=CONT].scoper",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Specimen.container.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.container.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Specimen.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Specimen.container.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Specimen.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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "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.",
"isModifier": false,
"short": "Id for the container",
"mapping": [ {
"map": "SAC-3",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Specimen.container.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.container.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.container.description",
"min": 1,
"definition": "Textual description of the container.",
"isModifier": false,
"short": "Textual description of the container",
"mapping": [ {
"map": ".desc",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Specimen.container.description",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.container.type",
"min": 0,
"definition": "The type of container associated with the specimen (e.g. slide, aliquot, etc.).",
"isModifier": false,
"short": "Kind of container directly associated with specimen",
"mapping": [ {
"map": "SPM-27",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-container-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainerType"
} ],
"description": "Type of specimen container."
},
"max": "1",
"id": "Specimen.container.type",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.container.capacity",
"min": 0,
"definition": "The capacity (volume or other measure) the container may contain.",
"isModifier": false,
"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.container.capacity",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.capacity"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"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.container.specimenQuantity",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.specimenQuantity"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.container.additive[x]",
"min": 0,
"definition": "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"isModifier": false,
"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" ]
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0371",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainerAdditive"
} ],
"description": "Substance added to specimen container."
},
"max": "1",
"id": "Specimen.container.additive[x]",
"base": {
"max": "1",
"min": 0,
"path": "Specimen.container.additive[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Specimen.condition",
"requirements": "The specimen condition can be used to assess its quality or appropriateness for a specific test.",
"min": 0,
"definition": "A mode or state of being that describes the nature of the specimen.",
"isModifier": false,
"short": "State of the specimen",
"mapping": [ {
"map": "SPM-24",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0493",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenCondition"
} ],
"description": "Codes describing the state of the specimen."
},
"max": "*",
"id": "Specimen.condition",
"comment": "Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.condition"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "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).",
"isModifier": false,
"short": "Details or issues about the specimen or reason for no analysis",
"mapping": [ {
"map": "OBX",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"mustSupport": true,
"max": "*",
"label": "Details or issues about the specimen or reason for no analysis",
"id": "Specimen.note",
"base": {
"max": "*",
"min": 0,
"path": "Specimen.note"
},
"isSummary": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
} ]
},
"status": "active",
"id": "19c21c74-c949-454b-b80f-267a19cc7046",
"kind": "resource",
"url": "http://hl7.org/fhir/us/mdi/StructureDefinition/Specimen-toxicology-lab",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.11.42.24",
"system": "urn:ietf:rfc:3986"
} ],
"version": "2.0.0-snapshot2",
"differential": {
"element": [ {
"id": "Specimen",
"path": "Specimen",
"short": "The specimen sent by a Medical Examiner, Coroner, or autopsy performer to a toxicology lab for analysis.",
"definition": "The specimen sent by a Medical Examiner, Coroner, or autopsy performer to a toxicology lab for analysis."
}, {
"id": "Specimen.identifier",
"path": "Specimen.identifier",
"short": "System-generated identifier for this Specimen.",
"definition": "System-generated identifier for this Specimen.",
"mustSupport": true
}, {
"id": "Specimen.accessionIdentifier",
"path": "Specimen.accessionIdentifier",
"mustSupport": true
}, {
"id": "Specimen.type",
"min": 1,
"path": "Specimen.type",
"short": "Type of tissue or material",
"definition": "Type of tissue or material (blood, etc.).",
"mustSupport": true
}, {
"id": "Specimen.type.coding",
"path": "Specimen.type.coding",
"mustSupport": true
}, {
"id": "Specimen.type.text",
"min": 1,
"path": "Specimen.type.text",
"mustSupport": true
}, {
"id": "Specimen.subject",
"path": "Specimen.subject",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ]
} ],
"short": "The subject is the decedent.",
"definition": "The subject is the decedent.",
"mustSupport": true
}, {
"id": "Specimen.receivedTime",
"path": "Specimen.receivedTime",
"label": "Time when specimen was received by the forensic toxicology lab for processing",
"short": "Time when specimen was received by the forensic toxicology lab for processing",
"mustSupport": true
}, {
"id": "Specimen.parent",
"path": "Specimen.parent",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/mdi/StructureDefinition/Specimen-toxicology-lab" ]
} ],
"mustSupport": true
}, {
"id": "Specimen.collection",
"path": "Specimen.collection",
"mustSupport": true
}, {
"id": "Specimen.collection.collected[x]",
"path": "Specimen.collection.collected[x]",
"label": "Time collected from either the body or the scene",
"short": "Time collected from either the body or the scene",
"mustSupport": true
}, {
"id": "Specimen.processing",
"path": "Specimen.processing",
"mustSupport": true
}, {
"id": "Specimen.processing.time[x]",
"path": "Specimen.processing.time[x]",
"mustSupport": true
}, {
"id": "Specimen.container.identifier",
"path": "Specimen.container.identifier",
"mustSupport": true
}, {
"id": "Specimen.container.description",
"min": 1,
"path": "Specimen.container.description"
}, {
"id": "Specimen.container.additive[x]",
"path": "Specimen.container.additive[x]",
"mustSupport": true
}, {
"id": "Specimen.condition",
"path": "Specimen.condition",
"mustSupport": true
}, {
"id": "Specimen.note",
"path": "Specimen.note",
"label": "Details or issues about the specimen or reason for no analysis",
"short": "Details or issues about the specimen or reason for no analysis",
"mustSupport": true
} ]
},
"contact": [ {
"name": "HL7 International / Public Health",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/pher",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Specimen"
}