. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 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 R3 R2
Profile for specimen
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Sample for analysis.\" class=\"dict\" href=\"specimen-definitions.html#Specimen\"><b>Specimen</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Id for specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Kind of material that forms the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v2/0487/index.html\">Kind of material that forms the specimen</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Parent specimen from which the focal specimen was a component.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source\"><b>source</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Parent of specimen --></span>\r\n <<a title=\"Whether this relationship is to a parent or to a child.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source.relationship\"><b>relationship</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"hierarchical-relationship-type.html\">parent | child</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The specimen resource that is the target of this relationship.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">The subject of the relationship</span><span style=\"color: Gray\"> --></span></target>\r\n </source>\r\n <<a title=\"Where the specimen came from. This may be the patient(s) or from the environment or a device.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">\r\n Where the specimen came from. This may be the patient(s) or from the environment or a device</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"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.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.accessionIdentifier\"><b>accessionIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier assigned by the lab</span><span style=\"color: Gray\"> --></span></accessionIdentifier>\r\n <<a title=\"Time when specimen was received for processing or testing.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.receivedTime\"><b>receivedTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The time when specimen was received for processing</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details concerning the specimen collection.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection\"><b>collection</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> Collection details --></span>\r\n <<a title=\"Person who collected the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.collector\"><b>collector</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the specimen</span><span style=\"color: Gray\"> --></span></collector>\r\n <<a title=\"To communicate any details or issues encountered during the specimen collection procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.comment\"><b>comment</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Collector comments</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Time when specimen was collected from subject - the physiologically relevant time.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.collected_x_\"><b>collected[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Collection time</span><span style=\"color: Gray\"> --></span></collected[x]>\r\n <<a title=\"The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">The quantity of specimen collected</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"A coded value specifying the technique that is used to perform the procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-collection-method.html\">Technique used to perform collection</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.sourceSite\"><b>sourceSite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Anatomical collection site</a></span><span style=\"color: Gray\"> --></span></sourceSite>\r\n </collection>\r\n <<a title=\"Details concerning treatment and processing steps for the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment\"><b>treatment</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Treatment and processing step details --></span>\r\n <<a title=\"Textual description of procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of procedure</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A coded value specifying the procedure used to process the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.procedure\"><b>procedure</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-treatment-procedure.html\">Indicates the treatment or processing step applied to the specimen</a></span><span style=\"color: Gray\"> --></span></procedure>\r\n <<a title=\"Material used in the processing step.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.additive\"><b>additive</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Material used in the processing step</span><span style=\"color: Gray\"> --></span></additive>\r\n </treatment>\r\n <<a title=\"The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container\"><b>container</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Direct container of specimen (tube/slide, etc) --></span>\r\n <<a title=\"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.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Id for the container</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Textual description of the container.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of the container</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of container associated with the specimen (e.g. slide, aliquot, etc).\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-container-type.html\">Kind of container directly associated with specimen</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The capacity (volume or other measure) the container may contain.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.capacity\"><b>capacity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Container volume or size</span><span style=\"color: Gray\"> --></span></capacity>\r\n <<a title=\"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.specimenQuantity\"><b>specimenQuantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Quantity of specimen within container</span><span style=\"color: Gray\"> --></span></specimenQuantity>\r\n <<a title=\"Additive associated with the container.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.additive\"><b>additive</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Additive associated with container</span><span style=\"color: Gray\"> --></span></additive>\r\n </container>\r\n</Specimen>\r\n</pre></div>"
},
"name": "specimen",
"publisher": "FHIR Project",
"description": "Basic Profile. Sample for analysis.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Any material sample:\r\n\r\n* taken from a biological entity, living or dead\r\n* taken from a physical object or the environment\r\nBiospecimen can contain one or more components including but not limited to cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory products (source: NCIt, modified). \r\n\r\nThe specimen resource covers substances used for diagnostic and environmental testing. The focus of the specimen resource is the process for gathering, maintaining and processing the specimen as well as where the specimen originated. This is distinct from the use of Substance which is only used when these other aspects are not relevant.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Specimen",
"publish": true,
"element": [
{
"path": "Specimen",
"definition": {
"short": "Sample for analysis",
"formal": "Sample for analysis.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
}
]
}
},
{
"path": "Specimen.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Specimen.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Specimen.identifier",
"definition": {
"short": "External Identifier",
"formal": "Id for specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "SPM-2"
}
]
}
},
{
"path": "Specimen.type",
"definition": {
"short": "Kind of material that forms the specimen",
"formal": "Kind of material that forms the specimen.",
"comments": "The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v2/vs/0487"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "SPM-4 and possibly SPM-5"
}
]
}
},
{
"path": "Specimen.source",
"definition": {
"short": "Parent of specimen",
"formal": "Parent specimen from which the focal specimen was a component.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scoper (if parent)\n.player.scopesRole[classCode=SPEC].player (if child)"
}
]
}
},
{
"path": "Specimen.source.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.source.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.source.relationship",
"definition": {
"short": "parent | child",
"formal": "Whether this relationship is to a parent or to a child.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "HierarchicalRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/hierarchical-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "as above"
},
{
"identity": "v2",
"map": "not explicit in v2.x SPM segment, but can be\nderived as child,if SPM-3 Specimen parent ID is filled in"
}
]
}
},
{
"path": "Specimen.source.target",
"definition": {
"short": "The subject of the relationship",
"formal": "The specimen resource that is the target of this relationship.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "[self]"
}
]
}
},
{
"path": "Specimen.subject",
"definition": {
"short": "Where the specimen came from. This may be the patient(s) or from the environment or a device",
"formal": "Where the specimen came from. This may be the patient(s) or from the environment or a device.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scoper\n\nor\n\n.scoper.playsRole"
}
]
}
},
{
"path": "Specimen.accessionIdentifier",
"definition": {
"short": "Identifier assigned by the lab",
"formal": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "v2",
"map": "SPM-30 (v2.7+)"
}
]
}
},
{
"path": "Specimen.receivedTime",
"definition": {
"short": "The time when specimen was received for processing",
"formal": "Time when specimen was received for processing or testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
},
{
"identity": "v2",
"map": "SPM-18"
}
]
}
},
{
"path": "Specimen.collection",
"definition": {
"short": "Collection details",
"formal": "Details concerning the specimen collection.",
"min": 1,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}
]
}
},
{
"path": "Specimen.collection.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.collection.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.collection.collector",
"definition": {
"short": "Who collected the specimen",
"formal": "Person who collected the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
}
},
{
"path": "Specimen.collection.comment",
"definition": {
"short": "Collector comments",
"formal": "To communicate any details or issues encountered during the specimen collection procedure.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
},
{
"path": "Specimen.collection.collected[x]",
"definition": {
"short": "Collection time",
"formal": "Time when specimen was collected from subject - the physiologically relevant time.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "SPM-17"
}
]
}
},
{
"path": "Specimen.collection.quantity",
"definition": {
"short": "The quantity of specimen collected",
"formal": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
},
{
"identity": "v2",
"map": "SPM-12"
}
]
}
},
{
"path": "Specimen.collection.method",
"definition": {
"short": "Technique used to perform collection",
"formal": "A coded value specifying the technique that is used to perform the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenCollectionMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/specimen-collection-method"
}
},
"mapping": [
{
"identity": "rim",
"map": ".methodCode"
},
{
"identity": "v2",
"map": "SPM-7"
}
]
}
},
{
"path": "Specimen.collection.sourceSite",
"definition": {
"short": "Anatomical collection site",
"formal": "Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "BodySite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
},
{
"identity": "v2",
"map": "SPM-8 and SPM-9"
}
]
}
},
{
"path": "Specimen.treatment",
"definition": {
"short": "Treatment and processing step details",
"formal": "Details concerning treatment and processing steps for the specimen.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}
]
}
},
{
"path": "Specimen.treatment.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.treatment.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.treatment.description",
"definition": {
"short": "Textual description of procedure",
"formal": "Textual description of procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
},
{
"path": "Specimen.treatment.procedure",
"definition": {
"short": "Indicates the treatment or processing step applied to the specimen",
"formal": "A coded value specifying the procedure used to process the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenTreatmentProcedure",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/specimen-treatment-procedure"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Specimen.treatment.additive",
"definition": {
"short": "Material used in the processing step",
"formal": "Material used in the processing step.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code"
},
{
"identity": "v2",
"map": "SPM-6"
}
]
}
},
{
"path": "Specimen.container",
"definition": {
"short": "Direct container of specimen (tube/slide, etc)",
"formal": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.scopingRole[classCode=CONT].scoper"
}
]
}
},
{
"path": "Specimen.container.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.container.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.container.identifier",
"definition": {
"short": "Id for the container",
"formal": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "SAC-3"
}
]
}
},
{
"path": "Specimen.container.description",
"definition": {
"short": "Textual description of the container",
"formal": "Textual description of the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".desc"
}
]
}
},
{
"path": "Specimen.container.type",
"definition": {
"short": "Kind of container directly associated with specimen",
"formal": "The type of container associated with the specimen (e.g. slide, aliquot, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenContainerType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/specimen-container-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "SPM-27"
}
]
}
},
{
"path": "Specimen.container.capacity",
"definition": {
"short": "Container volume or size",
"formal": "The capacity (volume or other measure) the container may contain.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
},
{
"identity": "v2",
"map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
}
]
}
},
{
"path": "Specimen.container.specimenQuantity",
"definition": {
"short": "Quantity of specimen within container",
"formal": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[classCode=CONT].quantity"
},
{
"identity": "v2",
"map": "SAC-23 (value) SAC-24 (units"
}
]
}
},
{
"path": "Specimen.container.additive",
"definition": {
"short": "Additive associated with container",
"formal": "Additive associated with the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[classCode=ADTV].player"
},
{
"identity": "v2",
"map": "SAC-27"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the specimen",
"xpath": "f:Specimen/f:subject"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change