R4 Draft for Comment
DiagnosticsThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Orders and Observations Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for specimendefinition
{
"resourceType": "StructureDefinition",
"id": "SpecimenDefinition",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "oo"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
"name": "SpecimenDefinition",
"status": "draft",
"date": "2017-12-20T15:52:34+11:00",
"publisher": "Health Level Seven International (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "A kind of specimen with associated set of requirements.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "SpecimenDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "SpecimenDefinition",
"path": "SpecimenDefinition",
"short": "Kind of specimen",
"definition": "A kind of specimen with associated set of requirements.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"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",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "OM4"
},
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "SpecimenDefinition.id",
"path": "SpecimenDefinition.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "SpecimenDefinition.meta",
"path": "SpecimenDefinition.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "SpecimenDefinition.implicitRules",
"path": "SpecimenDefinition.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "SpecimenDefinition.language",
"path": "SpecimenDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "SpecimenDefinition.text",
"path": "SpecimenDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "SpecimenDefinition.contained",
"path": "SpecimenDefinition.contained",
"short": "Contained, inline Resources",
"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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SpecimenDefinition.extension",
"path": "SpecimenDefinition.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SpecimenDefinition.modifierExtension",
"path": "SpecimenDefinition.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SpecimenDefinition.identifier",
"path": "SpecimenDefinition.identifier",
"short": "Business identifier of a kind of specimen",
"definition": "A business identifier associated with the kind of specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"id": "SpecimenDefinition.typeCollected",
"path": "SpecimenDefinition.typeCollected",
"short": "Kind of material to collect",
"definition": "The kind of material to be collected.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CollectedSpecimenType"
}
],
"strength": "example",
"description": "The type of the specimen to be collected.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0487"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-6"
}
]
},
{
"id": "SpecimenDefinition.patientPreparation",
"path": "SpecimenDefinition.patientPreparation",
"short": "Patient preparation for collection",
"definition": "Preparation of the patient for specimen collection.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "6 hours fasting ; no effort in last hour"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM1-37"
}
]
},
{
"id": "SpecimenDefinition.timeAspect",
"path": "SpecimenDefinition.timeAspect",
"short": "Time aspect for collection",
"definition": "Time aspect of specimen collection (duration or offset).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "24 hour, 20' post charge"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OM1-43, OM1-44"
}
]
},
{
"id": "SpecimenDefinition.collection",
"path": "SpecimenDefinition.collection",
"short": "Specimen collection procedure",
"definition": "The action to be performed for collecting the specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenCollection"
}
],
"strength": "example",
"description": "The action to collect a type of specimen"
}
},
{
"id": "SpecimenDefinition.specimenToLab",
"path": "SpecimenDefinition.specimenToLab",
"short": "Specimen in container intended for testing by lab",
"definition": "Specimen conditioned in a container as expected by the testing laboratory.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.id",
"path": "SpecimenDefinition.specimenToLab.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.extension",
"path": "SpecimenDefinition.specimenToLab.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.modifierExtension",
"path": "SpecimenDefinition.specimenToLab.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.isDerived",
"path": "SpecimenDefinition.specimenToLab.isDerived",
"short": "Primary or secondary specimen",
"definition": "Primary of secondary specimen.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"example": [
{
"label": "General",
"valueBoolean": false
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-2"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.type",
"path": "SpecimenDefinition.specimenToLab.type",
"short": "Type of intended specimen",
"definition": "The kind of specimen conditioned for testing expected by lab.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IntendedSpecimenType"
}
],
"strength": "example",
"description": "The type of specimen conditioned in a container for lab testing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0487"
}
}
},
{
"id": "SpecimenDefinition.specimenToLab.preference",
"path": "SpecimenDefinition.specimenToLab.preference",
"short": "preferred | alternate",
"definition": "The preference for this type of conditioned specimen.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"example": [
{
"label": "General",
"valueCode": "preferred, alternate"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainedPreference"
}
],
"strength": "required",
"description": "Degree of preference of a type of conditioned specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-contained-preference"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-16"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerMaterial",
"path": "SpecimenDefinition.specimenToLab.containerMaterial",
"short": "Container material",
"definition": "The type of material of the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerType",
"path": "SpecimenDefinition.specimenToLab.containerType",
"short": "Kind of container associated with the kind of specimen",
"definition": "The type of container used to contain this kind of specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContainerType"
}
],
"strength": "example",
"description": "Type of specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
}
},
{
"id": "SpecimenDefinition.specimenToLab.containerCap",
"path": "SpecimenDefinition.specimenToLab.containerCap",
"short": "Color of container cap",
"definition": "Color of container cap.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContainerCap"
}
],
"strength": "example",
"description": "Color of the container cap",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/container-cap"
}
}
},
{
"id": "SpecimenDefinition.specimenToLab.containerDescription",
"path": "SpecimenDefinition.specimenToLab.containerDescription",
"short": "Container description",
"definition": "The textual description of the kind of container.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "Blue top tube with citrate"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-3"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerCapacity",
"path": "SpecimenDefinition.specimenToLab.containerCapacity",
"short": "Container capacity",
"definition": "The capacity (volume or other measure) of this kind of container.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-4, OM4-5"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerMinimumVolume",
"path": "SpecimenDefinition.specimenToLab.containerMinimumVolume",
"short": "Minimum volume",
"definition": "The minimum volume to be conditioned in the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-11"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerAdditive",
"path": "SpecimenDefinition.specimenToLab.containerAdditive",
"short": "Additive associated with container",
"definition": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-7"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerAdditive.id",
"path": "SpecimenDefinition.specimenToLab.containerAdditive.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerAdditive.extension",
"path": "SpecimenDefinition.specimenToLab.containerAdditive.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerAdditive.modifierExtension",
"path": "SpecimenDefinition.specimenToLab.containerAdditive.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerAdditive.additive[x]",
"path": "SpecimenDefinition.specimenToLab.containerAdditive.additive[x]",
"short": "Additive associated with container",
"definition": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContainerAdditive"
}
],
"strength": "example",
"description": "Substance added to specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0371"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-7"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerPreparation",
"path": "SpecimenDefinition.specimenToLab.containerPreparation",
"short": "Specimen container preparation",
"definition": "Special processing that should be applied to the container for this kind of specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-8"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.requirement",
"path": "SpecimenDefinition.specimenToLab.requirement",
"short": "Specimen requirements",
"definition": "Requirements for delivery and special handling of this kind of conditioned specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-12"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.retentionTime",
"path": "SpecimenDefinition.specimenToLab.retentionTime",
"short": "Specimen retention time",
"definition": "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-14"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.rejectionCriterion",
"path": "SpecimenDefinition.specimenToLab.rejectionCriterion",
"short": "Rejection criterion",
"definition": "Criterion for rejection of the specimen in its container by the laboratory.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RejectionCriterion"
}
],
"strength": "example",
"description": "Criterion for rejection of the specimen by laboratory",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/rejection-criteria"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM1-39"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling",
"path": "SpecimenDefinition.specimenToLab.handling",
"short": "Specimen handling before testing",
"definition": "Set of instructions for conservation/transport of the specimen at a defined temperature interval, prior the testing process.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.id",
"path": "SpecimenDefinition.specimenToLab.handling.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.extension",
"path": "SpecimenDefinition.specimenToLab.handling.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.modifierExtension",
"path": "SpecimenDefinition.specimenToLab.handling.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.conditionSet",
"path": "SpecimenDefinition.specimenToLab.handling.conditionSet",
"short": "Conservation condition set",
"definition": "Code representing the set of handling instructions.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HandlingConditionSet"
}
],
"strength": "example",
"description": "Set of handling instructions prior testing of the specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/handling-condition"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-15"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.tempRange",
"path": "SpecimenDefinition.specimenToLab.handling.tempRange",
"short": "Temperature range",
"definition": "The temperature interval for this set of handling instructions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.maxDuration",
"path": "SpecimenDefinition.specimenToLab.handling.maxDuration",
"short": "Maximum conservation time",
"definition": "The maximum time interval of conservation of the specimen with these conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.lightExposure",
"path": "SpecimenDefinition.specimenToLab.handling.lightExposure",
"short": "Light exposure",
"definition": "Textual instructions regarding the light exposure of the specimen prior testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "protect from any source of light"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.instruction",
"path": "SpecimenDefinition.specimenToLab.handling.instruction",
"short": "Conservation instruction",
"definition": "Additional textual instructions for the conservation or transport of the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "freeze within 4 hours"
}
]
}
]
},
"differential": {
"element": [
{
"id": "SpecimenDefinition",
"path": "SpecimenDefinition",
"short": "Kind of specimen",
"definition": "A kind of specimen with associated set of requirements.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "OM4"
},
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "SpecimenDefinition.identifier",
"path": "SpecimenDefinition.identifier",
"short": "Business identifier of a kind of specimen",
"definition": "A business identifier associated with the kind of specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"id": "SpecimenDefinition.typeCollected",
"path": "SpecimenDefinition.typeCollected",
"short": "Kind of material to collect",
"definition": "The kind of material to be collected.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CollectedSpecimenType"
}
],
"strength": "example",
"description": "The type of the specimen to be collected.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0487"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-6"
}
]
},
{
"id": "SpecimenDefinition.patientPreparation",
"path": "SpecimenDefinition.patientPreparation",
"short": "Patient preparation for collection",
"definition": "Preparation of the patient for specimen collection.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "6 hours fasting ; no effort in last hour"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM1-37"
}
]
},
{
"id": "SpecimenDefinition.timeAspect",
"path": "SpecimenDefinition.timeAspect",
"short": "Time aspect for collection",
"definition": "Time aspect of specimen collection (duration or offset).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "24 hour, 20' post charge"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OM1-43, OM1-44"
}
]
},
{
"id": "SpecimenDefinition.collection",
"path": "SpecimenDefinition.collection",
"short": "Specimen collection procedure",
"definition": "The action to be performed for collecting the specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenCollection"
}
],
"strength": "example",
"description": "The action to collect a type of specimen"
}
},
{
"id": "SpecimenDefinition.specimenToLab",
"path": "SpecimenDefinition.specimenToLab",
"short": "Specimen in container intended for testing by lab",
"definition": "Specimen conditioned in a container as expected by the testing laboratory.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.isDerived",
"path": "SpecimenDefinition.specimenToLab.isDerived",
"short": "Primary or secondary specimen",
"definition": "Primary of secondary specimen.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"example": [
{
"label": "General",
"valueBoolean": false
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-2"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.type",
"path": "SpecimenDefinition.specimenToLab.type",
"short": "Type of intended specimen",
"definition": "The kind of specimen conditioned for testing expected by lab.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IntendedSpecimenType"
}
],
"strength": "example",
"description": "The type of specimen conditioned in a container for lab testing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0487"
}
}
},
{
"id": "SpecimenDefinition.specimenToLab.preference",
"path": "SpecimenDefinition.specimenToLab.preference",
"short": "preferred | alternate",
"definition": "The preference for this type of conditioned specimen.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"example": [
{
"label": "General",
"valueCode": "preferred, alternate"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainedPreference"
}
],
"strength": "required",
"description": "Degree of preference of a type of conditioned specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-contained-preference"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-16"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerMaterial",
"path": "SpecimenDefinition.specimenToLab.containerMaterial",
"short": "Container material",
"definition": "The type of material of the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerType",
"path": "SpecimenDefinition.specimenToLab.containerType",
"short": "Kind of container associated with the kind of specimen",
"definition": "The type of container used to contain this kind of specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContainerType"
}
],
"strength": "example",
"description": "Type of specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
}
},
{
"id": "SpecimenDefinition.specimenToLab.containerCap",
"path": "SpecimenDefinition.specimenToLab.containerCap",
"short": "Color of container cap",
"definition": "Color of container cap.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContainerCap"
}
],
"strength": "example",
"description": "Color of the container cap",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/container-cap"
}
}
},
{
"id": "SpecimenDefinition.specimenToLab.containerDescription",
"path": "SpecimenDefinition.specimenToLab.containerDescription",
"short": "Container description",
"definition": "The textual description of the kind of container.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "Blue top tube with citrate"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-3"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerCapacity",
"path": "SpecimenDefinition.specimenToLab.containerCapacity",
"short": "Container capacity",
"definition": "The capacity (volume or other measure) of this kind of container.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-4, OM4-5"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerMinimumVolume",
"path": "SpecimenDefinition.specimenToLab.containerMinimumVolume",
"short": "Minimum volume",
"definition": "The minimum volume to be conditioned in the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-11"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerAdditive",
"path": "SpecimenDefinition.specimenToLab.containerAdditive",
"short": "Additive associated with container",
"definition": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-7"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerAdditive.additive[x]",
"path": "SpecimenDefinition.specimenToLab.containerAdditive.additive[x]",
"short": "Additive associated with container",
"definition": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContainerAdditive"
}
],
"strength": "example",
"description": "Substance added to specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0371"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-7"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.containerPreparation",
"path": "SpecimenDefinition.specimenToLab.containerPreparation",
"short": "Specimen container preparation",
"definition": "Special processing that should be applied to the container for this kind of specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-8"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.requirement",
"path": "SpecimenDefinition.specimenToLab.requirement",
"short": "Specimen requirements",
"definition": "Requirements for delivery and special handling of this kind of conditioned specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-12"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.retentionTime",
"path": "SpecimenDefinition.specimenToLab.retentionTime",
"short": "Specimen retention time",
"definition": "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"mapping": [
{
"identity": "v2",
"map": "OM4-14"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.rejectionCriterion",
"path": "SpecimenDefinition.specimenToLab.rejectionCriterion",
"short": "Rejection criterion",
"definition": "Criterion for rejection of the specimen in its container by the laboratory.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RejectionCriterion"
}
],
"strength": "example",
"description": "Criterion for rejection of the specimen by laboratory",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/rejection-criteria"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM1-39"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling",
"path": "SpecimenDefinition.specimenToLab.handling",
"short": "Specimen handling before testing",
"definition": "Set of instructions for conservation/transport of the specimen at a defined temperature interval, prior the testing process.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.conditionSet",
"path": "SpecimenDefinition.specimenToLab.handling.conditionSet",
"short": "Conservation condition set",
"definition": "Code representing the set of handling instructions.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HandlingConditionSet"
}
],
"strength": "example",
"description": "Set of handling instructions prior testing of the specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/handling-condition"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM4-15"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.tempRange",
"path": "SpecimenDefinition.specimenToLab.handling.tempRange",
"short": "Temperature range",
"definition": "The temperature interval for this set of handling instructions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.maxDuration",
"path": "SpecimenDefinition.specimenToLab.handling.maxDuration",
"short": "Maximum conservation time",
"definition": "The maximum time interval of conservation of the specimen with these conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.lightExposure",
"path": "SpecimenDefinition.specimenToLab.handling.lightExposure",
"short": "Light exposure",
"definition": "Textual instructions regarding the light exposure of the specimen prior testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "protect from any source of light"
}
]
},
{
"id": "SpecimenDefinition.specimenToLab.handling.instruction",
"path": "SpecimenDefinition.specimenToLab.handling.instruction",
"short": "Conservation instruction",
"definition": "Additional textual instructions for the conservation or transport of the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "freeze within 4 hours"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:58+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change