This page is part of the International Patient Summary Implementation Guide (v0.3.0: STU 1 (FHIR R4) Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
JSON Format: StructureDefinition-Specimen-uv-ips
Download Raw json
{
"resourceType" : "StructureDefinition",
"id" : "Specimen-uv-ips",
"meta" : {
"lastUpdated" : "2018-02-09T15:49:57.382-05:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">This profile constrains the Specimen resource to represent the characteristics of a biological specimens in the context of laboratory results integrated to a patient summary</div>"
},
"url" : "http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips",
"version" : "0.3.0",
"name" : "SpecimenUvIps",
"title" : "Specimen (IPS)",
"status" : "draft",
"date" : "2018-03-09T00:00:00-05:00",
"publisher" : "HL7 International",
"description" : "This profile constrains the Specimen resource to represent the characteristics of a biological specimens in the context of laboratory results integrated to a patient summary",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"purpose" : "Minimal specimen attributes, usable for the laboratory results section and entry of a patient summary",
"fhirVersion" : "4.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Specimen",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Specimen",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Specimen",
"path" : "Specimen",
"short" : "Sample for analysis",
"definition" : "A sample to be used for analysis.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "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" : "DomainResource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Role[classCode=SPEC]"
}
]
},
{
"id" : "Specimen.id",
"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.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Specimen.meta",
"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 might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Specimen.implicitRules",
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Specimen.language",
"path" : "Specimen.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Specimen.text",
"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 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" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Specimen.contained",
"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.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.extension",
"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. 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" : "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"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.modifierExtension",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.identifier",
"path" : "Specimen.identifier",
"short" : "External Identifier",
"definition" : "Id for specimen.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SPM-2"
},
{
"identity" : "rim",
"map" : ".id"
}
]
},
{
"id" : "Specimen.accessionIdentifier",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.accessionIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SPM-30 (v2.7+)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
}
]
},
{
"id" : "Specimen.status",
"path" : "Specimen.status",
"short" : "available | unavailable | unsatisfactory | entered-in-error",
"definition" : "The availability of the specimen.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.status",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenStatus"
}
],
"strength" : "required",
"description" : "Codes providing the status/availability of a specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-status|4.0.0"
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "SPM-20"
},
{
"identity" : "rim",
"map" : "status"
}
]
},
{
"id" : "Specimen.type",
"path" : "Specimen.type",
"short" : "Kind of material that forms the specimen",
"definition" : "The kind of material that forms the specimen.",
"comment" : "The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Specimen.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenType"
}
],
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/uv/ips/ValueSet/specimen-type-uv-ips"
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "SPM-4 and possibly SPM-5"
},
{
"identity" : "rim",
"map" : ".code"
}
]
},
{
"id" : "Specimen.type.id",
"path" : "Specimen.type.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.type.extension",
"path" : "Specimen.type.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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. 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" : "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"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.type.coding",
"path" : "Specimen.type.coding",
"short" : "A reference to a code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"comment" : "Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.",
"requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding",
"profile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
}
]
},
{
"id" : "Specimen.type.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Specimen.type.text",
"short" : "Plain text representation of the concept",
"definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comment" : "Very often the text is the same as a displayName of one of the codings.",
"requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeableConcept.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"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"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id" : "Specimen.subject",
"path" : "Specimen.subject",
"short" : "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" : "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" : "Must know the subject context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.subject",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips"
]
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".scoper or .scoper.playsRole"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}
]
},
{
"id" : "Specimen.subject.id",
"path" : "Specimen.subject.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.subject.extension",
"path" : "Specimen.subject.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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. 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" : "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"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.subject.reference",
"path" : "Specimen.subject.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ref-1"
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.subject.type",
"path" : "Specimen.subject.type",
"short" : "Type the reference refers to (e.g. \"Patient\")",
"definition" : "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment" : "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRResourceTypeExt"
}
],
"strength" : "extensible",
"description" : "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.subject.identifier",
"path" : "Specimen.subject.identifier",
"short" : "Logical reference, when literal reference is not known",
"definition" : "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Specimen.subject.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Specimen.subject.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.receivedTime",
"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" : "0",
"base" : {
"path" : "Specimen.receivedTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "SPM-18"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
}
]
},
{
"id" : "Specimen.parent",
"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.",
"comment" : "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Specimen.parent",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Specimen"
]
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)"
}
]
},
{
"id" : "Specimen.request",
"path" : "Specimen.request",
"short" : "Why the specimen was collected",
"definition" : "Details concerning a service request that required a specimen to be collected.",
"comment" : "The request may be explicit or implied such with a ServiceRequest that requires a blood draw.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Specimen.request",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"
]
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC? OBR-2/3?"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=FLFS].target"
}
]
},
{
"id" : "Specimen.collection",
"path" : "Specimen.collection",
"short" : "Collection details",
"definition" : "Details concerning the specimen collection.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "SPM-14"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}
]
},
{
"id" : "Specimen.collection.id",
"path" : "Specimen.collection.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.collection.extension",
"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. 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" : "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"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.collection.modifierExtension",
"path" : "Specimen.collection.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.collection.collector",
"path" : "Specimen.collection.collector",
"short" : "Who collected the specimen",
"definition" : "Person who collected the specimen.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Specimen.collection.collector",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"
]
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role"
}
]
},
{
"id" : "Specimen.collection.collected[x]",
"path" : "Specimen.collection.collected[x]",
"short" : "Collection time",
"definition" : "Time when specimen was collected from subject - the physiologically relevant time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.collected[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
},
{
"code" : "Period"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "v2",
"map" : "SPM-17"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Specimen.collection.duration",
"path" : "Specimen.collection.duration",
"short" : "How long it took to collect specimen",
"definition" : "The span of time over which the collection of a specimen occurred.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.duration",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Duration"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.init"
}
]
},
{
"id" : "Specimen.collection.quantity",
"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" : "0",
"base" : {
"path" : "Specimen.collection.quantity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Quantity",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "SPM-12"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
}
]
},
{
"id" : "Specimen.collection.method",
"path" : "Specimen.collection.method",
"short" : "Concept - reference to a terminology or just text",
"definition" : "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment" : "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.method",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept",
"profile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/uv/ips/ValueSet/specimen-collection-method-uv-ips"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"id" : "Specimen.collection.bodySite",
"path" : "Specimen.collection.bodySite",
"short" : "Concept - reference to a terminology or just text",
"definition" : "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment" : "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept",
"profile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"id" : "Specimen.collection.fastingStatus[x]",
"path" : "Specimen.collection.fastingStatus[x]",
"short" : "Whether or how long patient abstained from food and/or drink",
"definition" : "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.",
"comment" : "Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation ` such as `Observation.component code` = LOINC 49541-6 (Fasting status - Reported).",
"requirements" : "Many diagnostic tests require fasting to facilitate accurate interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.fastingStatus[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
},
{
"code" : "Duration"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FastingStatus"
}
],
"strength" : "extensible",
"description" : "Codes describing the fasting status of the patient.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0916"
},
"mapping" : [
{
"identity" : "v2",
"map" : "OBR-"
}
]
},
{
"id" : "Specimen.processing",
"path" : "Specimen.processing",
"short" : "Processing and processing step details",
"definition" : "Details concerning processing and processing steps for the specimen.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Specimen.processing",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}
]
},
{
"id" : "Specimen.processing.id",
"path" : "Specimen.processing.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.processing.extension",
"path" : "Specimen.processing.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. 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" : "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"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.processing.modifierExtension",
"path" : "Specimen.processing.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.processing.description",
"path" : "Specimen.processing.description",
"short" : "Textual description of procedure",
"definition" : "Textual description of procedure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.processing.description",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".text"
}
]
},
{
"id" : "Specimen.processing.procedure",
"path" : "Specimen.processing.procedure",
"short" : "Indicates the treatment step applied to the specimen",
"definition" : "A coded value specifying the procedure used to process the specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.processing.procedure",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenProcessingProcedure"
}
],
"strength" : "example",
"description" : "Type indicating the technique used to process the specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-processing-procedure"
},
"mapping" : [
{
"identity" : "rim",
"map" : ".code"
}
]
},
{
"id" : "Specimen.processing.additive",
"path" : "Specimen.processing.additive",
"short" : "Material used in the processing step",
"definition" : "Material used in the processing step.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.processing.additive",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Substance"
]
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "SPM-6"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADTV].code"
}
]
},
{
"id" : "Specimen.processing.time[x]",
"path" : "Specimen.processing.time[x]",
"short" : "Date and time of specimen processing",
"definition" : "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.processing.time[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
},
{
"code" : "Period"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Specimen.container",
"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" : "0",
"base" : {
"path" : "Specimen.container",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".player.scopingRole[classCode=CONT].scoper"
}
]
},
{
"id" : "Specimen.container.id",
"path" : "Specimen.container.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.container.extension",
"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. 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" : "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"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Specimen.container.modifierExtension",
"path" : "Specimen.container.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Specimen.container.identifier",
"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"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "SAC-3"
},
{
"identity" : "rim",
"map" : ".id"
}
]
},
{
"id" : "Specimen.container.description",
"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"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".desc"
}
]
},
{
"id" : "Specimen.container.type",
"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"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainerType"
}
],
"strength" : "example",
"description" : "Type of specimen container.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-container-type"
},
"mapping" : [
{
"identity" : "v2",
"map" : "SPM-27"
},
{
"identity" : "rim",
"map" : ".code"
}
]
},
{
"id" : "Specimen.container.capacity",
"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"
]
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
},
{
"identity" : "rim",
"map" : ".quantity"
}
]
},
{
"id" : "Specimen.container.specimenQuantity",
"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"
]
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "SAC-23 (value) SAC-24 (units"
},
{
"identity" : "rim",
"map" : ".playedRole[classCode=CONT].quantity"
}
]
},
{
"id" : "Specimen.container.additive[x]",
"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",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Substance"
]
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainerAdditive"
}
],
"strength" : "example",
"description" : "Substance added to specimen container.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0371"
},
"mapping" : [
{
"identity" : "v2",
"map" : "SAC-27"
},
{
"identity" : "rim",
"map" : ".scopesRole[classCode=ADTV].player"
}
]
},
{
"id" : "Specimen.condition",
"path" : "Specimen.condition",
"short" : "State of the specimen",
"definition" : "A mode or state of being that describes the nature of the specimen.",
"comment" : "Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.",
"requirements" : "The specimen condition can be used to assess its quality or appropriateness for a specific test.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.condition",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCondition"
}
],
"strength" : "extensible",
"description" : "Codes describing the state of the specimen.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0493"
},
"mapping" : [
{
"identity" : "v2",
"map" : "SPM-24"
}
]
},
{
"id" : "Specimen.note",
"path" : "Specimen.note",
"short" : "Comments",
"definition" : "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.note",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Annotation"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Specimen",
"path" : "Specimen",
"mustSupport" : true
},
{
"id" : "Specimen.id",
"path" : "Specimen.id",
"mustSupport" : true
},
{
"id" : "Specimen.meta",
"path" : "Specimen.meta",
"mustSupport" : true
},
{
"id" : "Specimen.type",
"path" : "Specimen.type",
"min" : 1,
"mustSupport" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenType"
}
],
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/uv/ips/ValueSet/specimen-type-uv-ips"
}
},
{
"id" : "Specimen.type.coding",
"path" : "Specimen.type.coding",
"type" : [
{
"code" : "Coding",
"profile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips"
]
}
],
"mustSupport" : true
},
{
"id" : "Specimen.subject",
"path" : "Specimen.subject",
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips"
]
}
],
"mustSupport" : true
},
{
"id" : "Specimen.subject.reference",
"path" : "Specimen.subject.reference",
"min" : 1,
"mustSupport" : true
},
{
"id" : "Specimen.receivedTime",
"path" : "Specimen.receivedTime",
"max" : "0",
"mustSupport" : false
},
{
"id" : "Specimen.parent",
"path" : "Specimen.parent",
"max" : "0",
"mustSupport" : false
},
{
"id" : "Specimen.request",
"path" : "Specimen.request",
"max" : "0",
"mustSupport" : false
},
{
"id" : "Specimen.collection",
"path" : "Specimen.collection",
"mustSupport" : true
},
{
"id" : "Specimen.collection.collector",
"path" : "Specimen.collection.collector",
"max" : "0",
"mustSupport" : false
},
{
"id" : "Specimen.collection.quantity",
"path" : "Specimen.collection.quantity",
"max" : "0",
"mustSupport" : false
},
{
"id" : "Specimen.collection.method",
"path" : "Specimen.collection.method",
"type" : [
{
"code" : "CodeableConcept",
"profile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
]
}
],
"mustSupport" : true,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/uv/ips/ValueSet/specimen-collection-method-uv-ips"
}
},
{
"id" : "Specimen.collection.bodySite",
"path" : "Specimen.collection.bodySite",
"type" : [
{
"code" : "CodeableConcept",
"profile" : [
"http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
]
}
],
"mustSupport" : true,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
}
},
{
"id" : "Specimen.processing",
"path" : "Specimen.processing",
"max" : "0",
"mustSupport" : false
},
{
"id" : "Specimen.container",
"path" : "Specimen.container",
"max" : "0",
"mustSupport" : false
}
]
}
}
