This page is part of the Genetic Reporting Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR v3.3.0. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions 
XML representation of the specimen Profile.
Narrative view of the profile
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="specimen"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://build.fhir.org/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://build.fhir.org/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://build.fhir.org/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://build.fhir.org/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://build.fhir.org/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://build.fhir.org/formats.html#table" title="Legend for this format"><img src="http://build.fhir.org/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="specimen-definitions.html#Specimen" title="A sample to be used for analysis.">Specimen</a><a name="Specimen"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Specimen</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="specimen-definitions.html#Specimen.subject">subject</a><a name="Specimen.subject"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://build.fhir.org/references.html">Reference</a>(<a href="http://build.fhir.org/patient.html">Patient</a> | <a href="http://build.fhir.org/group.html">Group</a> | <a href="http://build.fhir.org/location.html">Location</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://build.fhir.org/formats.html#table" title="Legend for this format"><img src="http://build.fhir.org/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/specimen"/> <version value="2018may"/> <name value="Specimen"/> <status value="draft"/> <date value="2017-05-20"/> <publisher value="HL7 Clinical Genomics WG"/> <description value="Specimen"/> <fhirVersion value="3.3.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Specimen"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Specimen"/> <derivation value="constraint"/> <snapshot> <element id="Specimen"> <path value="Specimen"/> <short value="Specimen"/> <definition value="A sample to be used for analysis."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="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 value="contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())"/> <xpath value="not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"/> <source value="DomainResource"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="rim"/> <map value="Role[classCode=SPEC]"/> </mapping> </element> <element id="Specimen.id"> <path value="Specimen.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Specimen.meta"> <path value="Specimen.meta"/> <short value="Metadata about the resource"/> <definition value="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 value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Specimen.implicitRules"> <path value="Specimen.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="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."/> <comment value="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."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isModifierReason value="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 value="true"/> </element> <element id="Specimen.language"> <path value="Specimen.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/languages"/> </binding> </element> <element id="Specimen.text"> <path value="Specimen.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comment value="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 value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Specimen.contained"> <path value="Specimen.contained"/> <short value="Contained, inline Resources"/> <definition value="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 value="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 value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Specimen.extension"> <path value="Specimen.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Specimen.modifierExtension"> <path value="Specimen.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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. 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 value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isModifierReason value="Not known why this is labelled a modifier"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Specimen.identifier"> <path value="Specimen.identifier"/> <short value="External Identifier"/> <definition value="Id for specimen."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-2"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element id="Specimen.accessionIdentifier"> <path value="Specimen.accessionIdentifier"/> <short value="Identifier assigned by the lab"/> <definition value="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 value="0"/> <max value="1"/> <base> <path value="Specimen.accessionIdentifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-30 (v2.7+)"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"/> </mapping> </element> <element id="Specimen.status"> <path value="Specimen.status"/> <short value="available | unavailable | unsatisfactory | entered-in-error"/> <definition value="The availability of the specimen."/> <comment value="This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.status"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isModifierReason value="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 value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SpecimenStatus"/> </extension> <strength value="required"/> <description value="Codes providing the status/availability of a specimen."/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/specimen-status"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.status"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-20"/> </mapping> <mapping> <identity value="rim"/> <map value="status"/> </mapping> </element> <element id="Specimen.type"> <path value="Specimen.type"/> <short value="Kind of material that forms the specimen"/> <definition value="The kind of material that forms the specimen."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Specimen.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SpecimenType"/> </extension> <strength value="example"/> <description value="The type of the specimen."/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/v2-0487"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-4 and possibly SPM-5"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element id="Specimen.subject"> <path value="Specimen.subject"/> <short value="Where the specimen came from. This may be from patient(s),from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device"/> <definition value="Where the specimen came from. This may be from patient(s),from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device."/> <requirements value="Must know the subject context."/> <min value="1"/> <max value="1"/> <base> <path value="Specimen.subject"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.subject[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".scoper or .scoper.playsRole"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.subject"/> </mapping> </element> <element id="Specimen.receivedTime"> <path value="Specimen.receivedTime"/> <short value="The time when specimen was received for processing"/> <definition value="Time when specimen was received for processing or testing."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.receivedTime"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.done[x]"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-18"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"/> </mapping> </element> <element id="Specimen.parent"> <path value="Specimen.parent"/> <short value="Specimen from which this specimen originated"/> <definition value="Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen."/> <comment value="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."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen.parent"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Specimen"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)"/> </mapping> </element> <element id="Specimen.request"> <path value="Specimen.request"/> <short value="Why the specimen was collected"/> <definition value="Details concerning a service request that required a specimen to be collected."/> <comment value="The request may be explicit or implied such with a ServiceRequest that requires a blood draw."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen.request"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC? OBR-2/3?"/> </mapping> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=FLFS].target"/> </mapping> </element> <element id="Specimen.collection"> <path value="Specimen.collection"/> <short value="Collection details"/> <definition value="Details concerning the specimen collection."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.collection"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="SPM-14"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"/> </mapping> </element> <element id="Specimen.collection.id"> <path value="Specimen.collection.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Specimen.collection.extension"> <path value="Specimen.collection.extension"/> <short value="Additional content defined by implementations"/> <definition value="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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Specimen.collection.modifierExtension"> <path value="Specimen.collection.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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. 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isModifierReason value="modifierExtension is reserved for use where modifier extensions must be used"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Specimen.collection.collector"> <path value="Specimen.collection.collector"/> <short value="Who collected the specimen"/> <definition value="Person who collected the specimen."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.collection.collector"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.actor"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role"/> </mapping> </element> <element id="Specimen.collection.collected[x]"> <path value="Specimen.collection.collected[x]"/> <short value="Collection time"/> <definition value="Time when specimen was collected from subject - the physiologically relevant time."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.collection.collected[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.init"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-17"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </element> <element id="Specimen.collection.quantity"> <path value="Specimen.collection.quantity"/> <short value="The quantity of specimen collected"/> <definition value="The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.collection.quantity"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="SPM-12"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"/> </mapping> </element> <element id="Specimen.collection.method"> <path value="Specimen.collection.method"/> <short value="Technique used to perform collection"/> <definition value="A coded value specifying the technique that is used to perform the procedure."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.collection.method"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SpecimenCollectionMethod"/> </extension> <strength value="example"/> <description value="The technique that is used to perform the procedure"/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/specimen-collection-method"/> </binding> <mapping> <identity value="v2"/> <map value="SPM-7"/> </mapping> <mapping> <identity value="rim"/> <map value=".methodCode"/> </mapping> </element> <element id="Specimen.collection.bodySite"> <path value="Specimen.collection.bodySite"/> <short value="Anatomical collection site"/> <definition value="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."/> <comment value="If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [body-structure](extension-body-structure.html)."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.collection.bodySite"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="BodySite"/> </extension> <strength value="example"/> <description value="Codes describing anatomical locations. May include laterality."/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/body-site"/> </binding> <mapping> <identity value="v2"/> <map value="SPM-8 and SPM-9"/> </mapping> <mapping> <identity value="rim"/> <map value=".targetSiteCode"/> </mapping> </element> <element id="Specimen.processing"> <path value="Specimen.processing"/> <short value="Processing and processing step details"/> <definition value="Details concerning processing and processing steps for the specimen."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen.processing"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"/> </mapping> </element> <element id="Specimen.processing.id"> <path value="Specimen.processing.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Specimen.processing.extension"> <path value="Specimen.processing.extension"/> <short value="Additional content defined by implementations"/> <definition value="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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Specimen.processing.modifierExtension"> <path value="Specimen.processing.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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. 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isModifierReason value="modifierExtension is reserved for use where modifier extensions must be used"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Specimen.processing.description"> <path value="Specimen.processing.description"/> <short value="Textual description of procedure"/> <definition value="Textual description of procedure."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.processing.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> <element id="Specimen.processing.procedure"> <path value="Specimen.processing.procedure"/> <short value="Indicates the treatment step applied to the specimen"/> <definition value="A coded value specifying the procedure used to process the specimen."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.processing.procedure"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SpecimenProcessingProcedure"/> </extension> <strength value="example"/> <description value="Type indicating the technique used to process the specimen"/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/specimen-processing-procedure"/> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element id="Specimen.processing.additive"> <path value="Specimen.processing.additive"/> <short value="Material used in the processing step"/> <definition value="Material used in the processing step."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen.processing.additive"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Substance"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="SPM-6"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=ADTV].code"/> </mapping> </element> <element id="Specimen.processing.time[x]"> <path value="Specimen.processing.time[x]"/> <short value="Date and time of specimen processing"/> <definition value="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."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.processing.time[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </element> <element id="Specimen.container"> <path value="Specimen.container"/> <short value="Direct container of specimen (tube/slide, etc.)"/> <definition value="The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen.container"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".player.scopingRole[classCode=CONT].scoper"/> </mapping> </element> <element id="Specimen.container.id"> <path value="Specimen.container.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Specimen.container.extension"> <path value="Specimen.container.extension"/> <short value="Additional content defined by implementations"/> <definition value="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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Specimen.container.modifierExtension"> <path value="Specimen.container.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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. 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isModifierReason value="modifierExtension is reserved for use where modifier extensions must be used"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Specimen.container.identifier"> <path value="Specimen.container.identifier"/> <short value="Id for the container"/> <definition value="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 value="0"/> <max value="*"/> <base> <path value="Specimen.container.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="SAC-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element id="Specimen.container.description"> <path value="Specimen.container.description"/> <short value="Textual description of the container"/> <definition value="Textual description of the container."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.container.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".desc"/> </mapping> </element> <element id="Specimen.container.type"> <path value="Specimen.container.type"/> <short value="Kind of container directly associated with specimen"/> <definition value="The type of container associated with the specimen (e.g. slide, aliquot, etc.)."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.container.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SpecimenContainerType"/> </extension> <strength value="example"/> <description value="Type of specimen container"/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/specimen-container-type"/> </binding> <mapping> <identity value="v2"/> <map value="SPM-27"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element id="Specimen.container.capacity"> <path value="Specimen.container.capacity"/> <short value="Container volume or size"/> <definition value="The capacity (volume or other measure) the container may contain."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.container.capacity"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"/> </mapping> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </element> <element id="Specimen.container.specimenQuantity"> <path value="Specimen.container.specimenQuantity"/> <short value="Quantity of specimen within container"/> <definition value="The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.container.specimenQuantity"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="SAC-23 (value) SAC-24 (units"/> </mapping> <mapping> <identity value="rim"/> <map value=".playedRole[classCode=CONT].quantity"/> </mapping> </element> <element id="Specimen.container.additive[x]"> <path value="Specimen.container.additive[x]"/> <short value="Additive associated with container"/> <definition value="Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA."/> <min value="0"/> <max value="1"/> <base> <path value="Specimen.container.additive[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Substance"/> </type> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SpecimenContainerAdditive"/> </extension> <strength value="example"/> <description value="Substance added to specimen container"/> <valueSetCanonical value="http://hl7.org/fhir/ValueSet/v2-0371"/> </binding> <mapping> <identity value="v2"/> <map value="SAC-27"/> </mapping> <mapping> <identity value="rim"/> <map value=".scopesRole[classCode=ADTV].player"/> </mapping> </element> <element id="Specimen.note"> <path value="Specimen.note"/> <short value="Comments"/> <definition value="To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen)."/> <min value="0"/> <max value="*"/> <base> <path value="Specimen.note"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Annotation"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="OBX"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value"/> </mapping> </element> </snapshot> <differential> <element id="Specimen"> <path value="Specimen"/> <short value="Specimen"/> <definition value="A sample to be used for analysis."/> <mustSupport value="false"/> <isModifier value="false"/> </element> <element id="Specimen.subject"> <path value="Specimen.subject"/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <mustSupport value="true"/> <isModifier value="false"/> </element> </differential> </StructureDefinition>
© 2017+ HL7 International Clinical Genomics Work Group. Based on FHIR version (3.3.0-13671). IG generated on Wed, Apr 4, 2018 06:23+1000.
Links: Version History |
Table of Contents |
|
Propose a change