STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition for USLab Specimen Resource
{
"resourceType": "StructureDefinition",
"id": "uslab-spec",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/uslab-spec",
"name": "US Laboratory Specimen Profile",
"status": "draft",
"publisher": "Health Level Seven International (Orders and Observations - US Lab)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org"
}
]
}
],
"date": "2014-11-17",
"description": "USLab Specimen Resource",
"fhirVersion": "1.4.0",
"kind": "resource",
"abstract": false,
"baseType": "Specimen",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Specimen",
"derivation": "constraint",
"snapshot": {
"element": [
{
"path": "Specimen",
"name": "USLab-Spec",
"short": "USLab Specimen Resource",
"definition": "Specimen resource defined for the USLab Implementation Guides.",
"alias": [
"Sample"
],
"min": 0,
"max": "*",
"base": {
"path": "Specimen",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"path": "Specimen.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.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "Specimen.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"path": "Specimen.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.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Specimen.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Specimen.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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Specimen.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.",
"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.",
"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"
}
]
},
{
"path": "Specimen.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Specimen.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"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"
}
]
},
{
"path": "Specimen.identifier",
"name": "USLabPlacerSID",
"short": "External Identifier",
"definition": "Id for specimen.",
"comments": "In the test ordering workflow this would be the orderer's specimen identifer(Placer Specimen ID). In the context of the lab test reporting workflow, this could be both the orderer's specimen identifer and the laboratory assigned specimen identifier (Filler Specimen ID).",
"min": 0,
"max": "*",
"base": {
"path": "Specimen.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-2"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Specimen.identifier.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.identifier.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.identifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"fixedCode": "official",
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"path": "Specimen.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comments": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"path": "Specimen.identifier.system",
"short": "Placer URI",
"definition": "Placer URI.",
"requirements": "There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"path": "Specimen.identifier.value",
"short": "Placer Identifier",
"definition": "Placer Identifier.",
"comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"exampleString": "123456",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"path": "Specimen.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"path": "Specimen.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comments": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"path": "Specimen.accessionIdentifier",
"short": "Identifier assigned by the lab",
"definition": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.",
"requirements": "For Laboratory reporting this element is required.",
"alias": [
"Filler ID"
],
"min": 1,
"max": "1",
"base": {
"path": "Specimen.accessionIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-30 (v2.7+)"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Specimen.accessionIdentifier.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.accessionIdentifier.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.accessionIdentifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"fixedCode": "official",
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"path": "Specimen.accessionIdentifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comments": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"path": "Specimen.accessionIdentifier.system",
"short": "Filler URI",
"definition": "Filler URI.",
"requirements": "There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"path": "Specimen.accessionIdentifier.value",
"short": "Filler Identifier",
"definition": "Filler Identifier.",
"comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"exampleString": "123456",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"path": "Specimen.accessionIdentifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"path": "Specimen.accessionIdentifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comments": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"path": "Specimen.status",
"short": "available | unavailable | unsatisfactory | entered-in-error",
"definition": "The availability of the specimen.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.status",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Codes providing the status/availability of a specimen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-20"
},
{
"identity": "rim",
"map": "status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "Specimen.type",
"short": "Kind of material that forms the specimen",
"definition": "The kind of material that forms the specimen.",
"comments": "Systems SHALL be capable of sending/consuming the local code if one exists.",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Codes to describe the Specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/uslab-spec-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-4 and possibly SPM-5"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"path": "Specimen.type.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.type.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.type.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"alias": [
"Snomed Code"
],
"min": 1,
"max": "*",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
}
]
},
{
"path": "Specimen.type.coding.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.type.coding.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.type.coding.system",
"short": "Identity of the terminology system",
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comments": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
},
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
}
]
},
{
"path": "Specimen.type.coding.version",
"short": "Version of the system - if relevant",
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comments": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
},
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
}
]
},
{
"path": "Specimen.type.coding.code",
"short": "Symbol in syntax defined by the system",
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"comments": "SNOMED Clinical Terms is a systematically organized computer processable collection of medical terms providing codes, terms, synonyms and definitions used in clinical documentation and reporting.",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
},
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Specimen.type.coding.display",
"short": "Representation defined by the system",
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"comments": "The SNOMED-CT 'preferred name' is preferred although any SNOMED-CT 'synonym' can also be used. ( ihtsdo.org/snomed-ct/).",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
},
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
}
]
},
{
"path": "Specimen.type.coding.userSelected",
"short": "If this coding was chosen directly by the user",
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"comments": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.userSelected",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
},
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
}
]
},
{
"path": "Specimen.type.text",
"short": "Display text",
"definition": "This is the laboratory defined display text for the actual test result, if different from the code display names.",
"comments": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "Used when the laboratory define how the display text if different from the code display text.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
},
{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
}
]
},
{
"path": "Specimen.subject",
"short": "Patient",
"definition": "Patient.",
"requirements": "Must know the subject context.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"base": {
"path": "Specimen.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/uslab-patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/uslab-phpatient"
]
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scoper or .scoper.playsRole"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "Specimen.receivedTime",
"short": "The time when specimen was received for processing",
"definition": "Time when specimen was received for processing or testing.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.receivedTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-18"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"path": "Specimen.parent",
"short": "Specimen from which this specimen originated",
"definition": "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.",
"comments": "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.",
"min": 0,
"max": "*",
"base": {
"path": "Specimen.parent",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Specimen"
]
}
],
"mapping": [
{
"identity": "rim",
"map": ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)"
}
]
},
{
"path": "Specimen.collection",
"short": "Collection details",
"definition": "Details concerning the specimen collection.",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.collection",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-14"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}
]
},
{
"path": "Specimen.collection.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"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"
}
]
},
{
"path": "Specimen.collection.collector",
"short": "Who collected the specimen",
"definition": "Person who collected the specimen.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.collection.collector",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRT"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"path": "Specimen.collection.comment",
"short": "Collector comments",
"definition": "To communicate any details or issues encountered during the specimen collection procedure.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.collection.comment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "Specimen.collection.collected[x]",
"short": "Collection time",
"definition": "Time when specimen was collected from subject - the physiologically relevant time.",
"requirements": "Minimum precision is to the day.",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.collection.collected[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"constraint": [
{
"key": "inv-2",
"severity": "error",
"human": "Datetime must be at least to the day.",
"expression": "value:length >= 8",
"xpath": "f:matches(.,/\\d{4}-[01]\\d-[0-3])/)"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-17"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"path": "Specimen.collection.quantity",
"short": "The quantity of specimen collected",
"definition": "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",
"base": {
"path": "Specimen.collection.quantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM-12"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
}
]
},
{
"path": "Specimen.collection.method",
"short": "Technique used to perform collection",
"definition": "A coded value specifying the technique that is used to perform the procedure.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.collection.method",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "The technique that is used to perform the procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-collection-method"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-7"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "Specimen.collection.bodySite",
"short": "Anatomical collection site",
"definition": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.",
"comments": "Systems SHALL be capable of sending/consuming the local code if one exists.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.collection.bodySite",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "Codes to describe the Specimen Collection Body site",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/uslab-spec-bodysite"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-8 and SPM-9"
},
{
"identity": "rim",
"map": ".targetSiteCode"
}
]
},
{
"path": "Specimen.collection.bodySite.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.bodySite.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.bodySite.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"max": "*",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
}
]
},
{
"path": "Specimen.collection.bodySite.coding.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.bodySite.coding.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.bodySite.coding.system",
"short": "Identity of the terminology system",
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comments": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
},
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
}
]
},
{
"path": "Specimen.collection.bodySite.coding.version",
"short": "Version of the system - if relevant",
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comments": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
},
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
}
]
},
{
"path": "Specimen.collection.bodySite.coding.code",
"short": "Symbol in syntax defined by the system",
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"comments": "SNOMED Clinical Terms is a systematically organized computer processable collection of medical terms providing codes, terms, synonyms and definitions used in clinical documentation and reporting.",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
},
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Specimen.collection.bodySite.coding.display",
"short": "Representation defined by the system",
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"comments": "The SNOMED-CT 'preferred name' is preferred although any SNOMED-CT 'synonym' can also be used. ( ihtsdo.org/snomed-ct/).",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
},
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
}
]
},
{
"path": "Specimen.collection.bodySite.coding.userSelected",
"short": "If this coding was chosen directly by the user",
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"comments": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.userSelected",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
},
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
}
]
},
{
"path": "Specimen.collection.bodySite.text",
"short": "Display text",
"definition": "This is the laboratory defined display text for the actual test result, if different from the code display names.",
"comments": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "Used when the laboratory define how the display text if different from the code display text.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
},
{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
}
]
},
{
"path": "Specimen.treatment",
"short": "Treatment and processing step details",
"definition": "Details concerning treatment and processing steps for the specimen.",
"min": 0,
"max": "*",
"base": {
"path": "Specimen.treatment",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}
]
},
{
"path": "Specimen.treatment.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.treatment.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.treatment.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"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"
}
]
},
{
"path": "Specimen.treatment.description",
"short": "Textual description of procedure",
"definition": "Textual description of procedure.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.treatment.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Specimen.treatment.procedure",
"short": "Indicates the treatment or processing step applied to the specimen",
"definition": "A coded value specifying the procedure used to process the specimen.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.treatment.procedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Type indicating the technique used to process the specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-treatment-procedure"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.treatment.additive",
"short": "Material used in the processing step",
"definition": "Material used in the processing step.",
"min": 0,
"max": "*",
"base": {
"path": "Specimen.treatment.additive",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Substance"
]
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM-6"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code"
}
]
},
{
"path": "Specimen.container",
"short": "Direct container of specimen (tube/slide, etc.)",
"definition": "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": "*",
"base": {
"path": "Specimen.container",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player.scopingRole[classCode=CONT].scoper"
}
]
},
{
"path": "Specimen.container.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.container.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.container.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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"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"
}
]
},
{
"path": "Specimen.container.identifier",
"short": "Id for the container",
"definition": "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.",
"min": 0,
"max": "*",
"base": {
"path": "Specimen.container.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SAC-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Specimen.container.description",
"short": "Textual description of the container",
"definition": "Textual description of the container.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.container.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".desc"
}
]
},
{
"path": "Specimen.container.type",
"short": "Kind of container directly associated with specimen",
"definition": "The type of container associated with the specimen (e.g. slide, aliquot, etc.).",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.container.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Type of specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-27"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.container.capacity",
"short": "Container volume or size",
"definition": "The capacity (volume or other measure) the container may contain.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.container.capacity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"mapping": [
{
"identity": "v2",
"map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Specimen.container.specimenQuantity",
"short": "Quantity of specimen within container",
"definition": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.container.specimenQuantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"mapping": [
{
"identity": "v2",
"map": "SAC-23 (value) SAC-24 (units"
},
{
"identity": "rim",
"map": ".playedRole[classCode=CONT].quantity"
}
]
},
{
"path": "Specimen.container.additive[x]",
"short": "Additive associated with container",
"definition": "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.container.additive[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Substance"
]
}
],
"binding": {
"strength": "example",
"description": "Substance added to specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0371"
}
},
"mapping": [
{
"identity": "v2",
"map": "SAC-27"
},
{
"identity": "rim",
"map": ".scopesRole[classCode=ADTV].player"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Specimen",
"name": "USLab-Spec",
"short": "USLab Specimen Resource",
"definition": "Specimen resource defined for the USLab Implementation Guides.",
"alias": [
"Sample"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Specimen"
}
]
},
{
"path": "Specimen.identifier",
"name": "USLabPlacerSID",
"comments": "In the test ordering workflow this would be the orderer's specimen identifer(Placer Specimen ID). In the context of the lab test reporting workflow, this could be both the orderer's specimen identifer and the laboratory assigned specimen identifier (Filler Specimen ID).",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"path": "Specimen.identifier.use",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"fixedCode": "official",
"mustSupport": true
},
{
"path": "Specimen.identifier.system",
"short": "Placer URI",
"definition": "Placer URI.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.identifier.value",
"short": "Placer Identifier",
"definition": "Placer Identifier.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.accessionIdentifier",
"requirements": "For Laboratory reporting this element is required.",
"alias": [
"Filler ID"
],
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.accessionIdentifier.use",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"fixedCode": "official",
"mustSupport": true
},
{
"path": "Specimen.accessionIdentifier.system",
"short": "Filler URI",
"definition": "Filler URI.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.accessionIdentifier.value",
"short": "Filler Identifier",
"definition": "Filler Identifier.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.type",
"comments": "Systems SHALL be capable of sending/consuming the local code if one exists.",
"min": 1,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "Codes to describe the Specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/uslab-spec-type"
}
}
},
{
"path": "Specimen.type.coding",
"alias": [
"Snomed Code"
],
"min": 1,
"max": "*",
"mustSupport": true
},
{
"path": "Specimen.type.coding.system",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.type.coding.code",
"comments": "SNOMED Clinical Terms is a systematically organized computer processable collection of medical terms providing codes, terms, synonyms and definitions used in clinical documentation and reporting.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.type.coding.display",
"comments": "The SNOMED-CT 'preferred name' is preferred although any SNOMED-CT 'synonym' can also be used. ( ihtsdo.org/snomed-ct/).",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.type.text",
"short": "Display text",
"definition": "This is the laboratory defined display text for the actual test result, if different from the code display names.",
"requirements": "Used when the laboratory define how the display text if different from the code display text.",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.subject",
"short": "Patient",
"definition": "Patient.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/uslab-patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/uslab-phpatient"
]
}
],
"mustSupport": true
},
{
"path": "Specimen.collection",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Specimen.collection.collected[x]",
"requirements": "Minimum precision is to the day.",
"min": 1,
"max": "1",
"condition": [
"inv-2"
],
"constraint": [
{
"key": "inv-2",
"severity": "error",
"human": "Datetime must be at least to the day.",
"expression": "value:length >= 8",
"xpath": "f:matches(.,/\\d{4}-[01]\\d-[0-3])/)"
}
],
"mustSupport": true
},
{
"path": "Specimen.collection.bodySite",
"comments": "Systems SHALL be capable of sending/consuming the local code if one exists.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "Codes to describe the Specimen Collection Body site",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/uslab-spec-bodysite"
}
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "Specimen.type.coding"
}
],
"path": "Specimen.collection.bodySite.coding",
"min": 1,
"max": "*",
"mustSupport": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "Specimen.type.coding.system"
}
],
"path": "Specimen.collection.bodySite.coding.system",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "Specimen.type.coding.code"
}
],
"path": "Specimen.collection.bodySite.coding.code",
"comments": "SNOMED Clinical Terms is a systematically organized computer processable collection of medical terms providing codes, terms, synonyms and definitions used in clinical documentation and reporting.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "Specimen.type.coding.display"
}
],
"path": "Specimen.collection.bodySite.coding.display",
"comments": "The SNOMED-CT 'preferred name' is preferred although any SNOMED-CT 'synonym' can also be used. ( ihtsdo.org/snomed-ct/).",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "Specimen.type.text"
}
],
"path": "Specimen.collection.bodySite.text",
"short": "Display text",
"definition": "This is the laboratory defined display text for the actual test result, if different from the code display names.",
"requirements": "Used when the laboratory define how the display text if different from the code display text.",
"min": 0,
"max": "1",
"mustSupport": true
}
]
}
}
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:10+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change