Release 5 Preview #3
DiagnosticsThis page is part of the FHIR Specification (v4.5.0: R5 Preview #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 
. Page versions: R5 R4B R4
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for specimendefinition
{
"resourceType" : "StructureDefinition",
"id" : "SpecimenDefinition",
"meta" : {
"lastUpdated" : "2020-08-20T17:41:31.970+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Definitional Artifacts"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
"version" : "4.5.0",
"name" : "SpecimenDefinition",
"status" : "draft",
"date" : "2020-08-20T17:41:31+10:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A kind of specimen with associated set of requirements.",
"fhirVersion" : "4.5.0",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SpecimenDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SpecimenDefinition",
"path" : "SpecimenDefinition",
"short" : "Kind of specimen",
"definition" : "A kind of specimen with associated set of requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition",
"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" : "http://hl7.org/fhir/StructureDefinition/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 $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "OM4"
},
{
"identity" : "rim",
"map" : "Role[classCode=SPEC]"
}]
},
{
"id" : "SpecimenDefinition.id",
"path" : "SpecimenDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.meta",
"path" : "SpecimenDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.implicitRules",
"path" : "SpecimenDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"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" : "SpecimenDefinition.language",
"path" : "SpecimenDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"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" : "SpecimenDefinition.text",
"path" : "SpecimenDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and 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 a 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"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SpecimenDefinition.contained",
"path" : "SpecimenDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, 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" : "SpecimenDefinition.extension",
"path" : "SpecimenDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. 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"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.modifierExtension",
"path" : "SpecimenDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/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" : "SpecimenDefinition.url",
"path" : "SpecimenDefinition.url",
"short" : "Logical canonical URL to reference this SpecimenDefinition (globally unique)",
"definition" : "An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.",
"comment" : "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.",
"requirements" : "Allows the SpecimenDefinition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.identifier",
"path" : "SpecimenDefinition.identifier",
"short" : "Business identifier",
"definition" : "A business identifier assigned to this SpecimenDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.version",
"path" : "SpecimenDefinition.version",
"short" : "Business version of the SpecimenDefinition",
"definition" : "The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.",
"comment" : "There may be multiple different instances of a SpecimenDefinition that have the same identifier but different versions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.title",
"path" : "SpecimenDefinition.title",
"short" : "Name for this SpecimenDefinition (Human friendly)",
"definition" : "A short, descriptive, user-friendly title for the SpecimenDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.derivedFromCanonical",
"path" : "SpecimenDefinition.derivedFromCanonical",
"short" : "Based on FHIR definition of another SpecimenDefinition",
"definition" : "The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.derivedFromCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"]
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.derivedFromUri",
"path" : "SpecimenDefinition.derivedFromUri",
"short" : "Based on external definition",
"definition" : "The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.",
"requirements" : "Specimen definitions may be refinements of other definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.derivedFromUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.status",
"path" : "SpecimenDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The current state of theSpecimenDefinition.",
"comment" : "A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation\nUnknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
}],
"strength" : "required",
"description" : "Codes identifying the status of a SpecimenDefinition resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.5.0"
}
},
{
"id" : "SpecimenDefinition.experimental",
"path" : "SpecimenDefinition.experimental",
"short" : "If this SpecimenDefinition is not for real usage",
"definition" : "A flag to indicate that this SpecimenDefinition is not authored for genuine usage.",
"comment" : "Allows filtering of SpecimenDefinition that are appropriate for use vs. not.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true
},
{
"id" : "SpecimenDefinition.subject[x]",
"path" : "SpecimenDefinition.subject[x]",
"short" : "Type of subject for specimen collection",
"definition" : "A code or group definition that describes the intended subject from which this kind of specimen is to be collected.",
"comment" : "Examples: person, animal, device, water ….",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.subject[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.date",
"path" : "SpecimenDefinition.date",
"short" : "Date status first applied",
"definition" : "For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.publisher",
"path" : "SpecimenDefinition.publisher",
"short" : "The name of the individual or organization that published the SpecimenDefinition",
"definition" : "Helps establish the \"authority/credibility\" of the SpecimenDefinition. May also allow for contact.",
"requirements" : "Usually an organization, but may be an individual. The publisher (or steward) of the SpecimenDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the SpecimenDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the SpecimenDefinition. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.contact",
"path" : "SpecimenDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.description",
"path" : "SpecimenDefinition.description",
"short" : "Natural language description of the SpecimenDefinition",
"definition" : "A free text natural language description of the SpecimenDefinition from the consumer's perspective.",
"comment" : "This description can be used to capture details such as why the SpecimenDefinition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.useContext",
"path" : "SpecimenDefinition.useContext",
"short" : "Content intends to support these contexts",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.",
"comment" : "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.jurisdiction",
"path" : "SpecimenDefinition.jurisdiction",
"short" : "Intended jurisdiction for this SpecimenDefinition (if applicable)",
"definition" : "A jurisdiction in which the SpecimenDefinition is intended to be used.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
}],
"strength" : "extensible",
"description" : "Codes for country, country subdivision and region for indicating where a resource is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
{
"id" : "SpecimenDefinition.purpose",
"path" : "SpecimenDefinition.purpose",
"short" : "Why this SpecimenDefinition is defined",
"definition" : "Explains why this SpecimeDefinition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the SpecimenDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this SpecimenDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.copyright",
"path" : "SpecimenDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.",
"requirements" : "Consumers of the SpecimenDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.approvalDate",
"path" : "SpecimenDefinition.approvalDate",
"short" : "When SpecimenDefinition was approved by publisher",
"definition" : "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.lastReviewDate",
"path" : "SpecimenDefinition.lastReviewDate",
"short" : "The date on which the asset content was last reviewed",
"definition" : "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comment" : "If specified, this is usually after the approval date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.effectivePeriod",
"path" : "SpecimenDefinition.effectivePeriod",
"short" : "The effective date range for the SpecimenDefinition",
"definition" : "The period during which the SpecimenDefinition content was or is planned to be effective.",
"comment" : "The effective period for a SpecimenDefinition determines when the content is applicable for usage and is independent of publication and review dates.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.typeCollected",
"path" : "SpecimenDefinition.typeCollected",
"short" : "Kind of material to collect",
"definition" : "The kind of material to be collected.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeCollected",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CollectedSpecimenType"
}],
"strength" : "example",
"description" : "The type of the specimen to be collected.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-6"
}]
},
{
"id" : "SpecimenDefinition.patientPreparation",
"path" : "SpecimenDefinition.patientPreparation",
"short" : "Patient preparation for collection",
"definition" : "Preparation of the patient for specimen collection.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.patientPreparation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PreparePatient"
}],
"strength" : "example",
"description" : "Checks on the patient prior specimen collection.",
"valueSet" : "http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-37"
}]
},
{
"id" : "SpecimenDefinition.timeAspect",
"path" : "SpecimenDefinition.timeAspect",
"short" : "Time aspect for collection",
"definition" : "Time aspect of specimen collection (duration or offset).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.timeAspect",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "24 hour, 20' post charge"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "OM1-43, OM1-44"
}]
},
{
"id" : "SpecimenDefinition.collection",
"path" : "SpecimenDefinition.collection",
"short" : "Specimen collection procedure",
"definition" : "The action to be performed for collecting the specimen.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.collection",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCollection"
}],
"strength" : "example",
"description" : "The action to collect a type of specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-collection"
}
},
{
"id" : "SpecimenDefinition.typeTested",
"path" : "SpecimenDefinition.typeTested",
"short" : "Specimen in container intended for testing by lab",
"definition" : "Specimen conditioned in a container as expected by the testing laboratory.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested",
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.id",
"path" : "SpecimenDefinition.typeTested.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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.extension",
"path" : "SpecimenDefinition.typeTested.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"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.modifierExtension",
"path" : "SpecimenDefinition.typeTested.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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/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" : "SpecimenDefinition.typeTested.isDerived",
"path" : "SpecimenDefinition.typeTested.isDerived",
"short" : "Primary or secondary specimen",
"definition" : "Primary of secondary specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.isDerived",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : false
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-2"
}]
},
{
"id" : "SpecimenDefinition.typeTested.type",
"path" : "SpecimenDefinition.typeTested.type",
"short" : "Type of intended specimen",
"definition" : "The kind of specimen conditioned for testing expected by lab.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IntendedSpecimenType"
}],
"strength" : "example",
"description" : "The type of specimen conditioned in a container for lab testing.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
}
},
{
"id" : "SpecimenDefinition.typeTested.preference",
"path" : "SpecimenDefinition.typeTested.preference",
"short" : "preferred | alternate",
"definition" : "The preference for this type of conditioned specimen.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.preference",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "preferred, alternate"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainedPreference"
}],
"strength" : "required",
"description" : "Degree of preference of a type of conditioned specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.5.0"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-16"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container",
"path" : "SpecimenDefinition.typeTested.container",
"short" : "The specimen's container",
"definition" : "The specimen's container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container",
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.container.id",
"path" : "SpecimenDefinition.typeTested.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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.extension",
"path" : "SpecimenDefinition.typeTested.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"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.modifierExtension",
"path" : "SpecimenDefinition.typeTested.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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/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" : "SpecimenDefinition.typeTested.container.material",
"path" : "SpecimenDefinition.typeTested.container.material",
"short" : "The material type used for the container",
"definition" : "The type of material of the container.",
"comment" : "Examples: glass, plastic, metal.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.material",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerMaterial"
}],
"strength" : "example",
"description" : "Types of material for specimen containers.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-material"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.type",
"path" : "SpecimenDefinition.typeTested.container.type",
"short" : "Kind of container associated with the kind of specimen",
"definition" : "The type of container used to contain this kind of specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerType"
}],
"strength" : "example",
"description" : "Type of specimen container.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.cap",
"path" : "SpecimenDefinition.typeTested.container.cap",
"short" : "Color of container cap",
"definition" : "Color of container cap.",
"requirements" : "From ISO 6710-2017 Table F.1 Recommended colour codes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.cap",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerCap"
}],
"strength" : "example",
"description" : "Color of the container cap.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-cap"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.description",
"path" : "SpecimenDefinition.typeTested.container.description",
"short" : "The description of the kind of container",
"definition" : "The textual description of the kind of container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "Blue top tube with citrate"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-3"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.capacity",
"path" : "SpecimenDefinition.typeTested.container.capacity",
"short" : "The capacity of this kind of container",
"definition" : "The capacity (volume or other measure) of this kind of container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.capacity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-4, OM4-5"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"path" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"short" : "Minimum volume",
"definition" : "The minimum volume to be conditioned in the container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "string"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-11"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive",
"path" : "SpecimenDefinition.typeTested.container.additive",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.additive",
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.id",
"path" : "SpecimenDefinition.typeTested.container.additive.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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.extension",
"path" : "SpecimenDefinition.typeTested.container.additive.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"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.modifierExtension",
"path" : "SpecimenDefinition.typeTested.container.additive.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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/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" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"path" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerAdditive"
}],
"strength" : "example",
"description" : "Substance added to specimen container.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0371"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.preparation",
"path" : "SpecimenDefinition.typeTested.container.preparation",
"short" : "Special processing applied to the container for this specimen type",
"definition" : "Special processing that should be applied to the container for this kind of specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.preparation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-8"
}]
},
{
"id" : "SpecimenDefinition.typeTested.requirement",
"path" : "SpecimenDefinition.typeTested.requirement",
"short" : "Requirements for specimen delivery and special handling",
"definition" : "Requirements for delivery and special handling of this kind of conditioned specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.requirement",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-12"
}]
},
{
"id" : "SpecimenDefinition.typeTested.retentionTime",
"path" : "SpecimenDefinition.typeTested.retentionTime",
"short" : "The usual time for retaining this kind of specimen",
"definition" : "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.retentionTime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-14"
}]
},
{
"id" : "SpecimenDefinition.typeTested.singleUse",
"path" : "SpecimenDefinition.typeTested.singleUse",
"short" : "Specimen for single use only",
"definition" : "Specimen can be used by only one test or panel if the value is \"true\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.singleUse",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.rejectionCriterion",
"path" : "SpecimenDefinition.typeTested.rejectionCriterion",
"short" : "Criterion specified for specimen rejection",
"definition" : "Criterion for rejection of the specimen in its container by the laboratory.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested.rejectionCriterion",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RejectionCriterion"
}],
"strength" : "example",
"description" : "Criterion for rejection of the specimen by laboratory.",
"valueSet" : "http://hl7.org/fhir/ValueSet/rejection-criteria"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-39"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling",
"path" : "SpecimenDefinition.typeTested.handling",
"short" : "Specimen handling before testing",
"definition" : "Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling",
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.handling.id",
"path" : "SpecimenDefinition.typeTested.handling.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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.extension",
"path" : "SpecimenDefinition.typeTested.handling.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.modifierExtension",
"path" : "SpecimenDefinition.typeTested.handling.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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/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" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"path" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"short" : "Qualifies the interval of temperature",
"definition" : "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "HandlingConditionSet"
}],
"strength" : "example",
"description" : "Set of handling instructions prior testing of the specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/handling-condition"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-15"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"path" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"short" : "Temperature range for these handling instructions",
"definition" : "The temperature interval for this set of handling instructions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.handling.maxDuration",
"path" : "SpecimenDefinition.typeTested.handling.maxDuration",
"short" : "Maximum preservation time",
"definition" : "The maximum time interval of preservation of the specimen with these conditions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.maxDuration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.handling.instruction",
"path" : "SpecimenDefinition.typeTested.handling.instruction",
"short" : "Preservation instruction",
"definition" : "Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.instruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "freeze within 4 hours"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.testingDestination",
"path" : "SpecimenDefinition.typeTested.testingDestination",
"short" : "Where the specimen will be tested",
"definition" : "Where the specimen will be tested: e.g., lab, sector, device or any combination of these.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested.testingDestination",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestingDestination"
}],
"strength" : "example",
"description" : "Codes specifying where the specimen will be tested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/diagnostic-service-sections"
}
}]
},
"differential" : {
"element" : [{
"id" : "SpecimenDefinition",
"path" : "SpecimenDefinition",
"short" : "Kind of specimen",
"definition" : "A kind of specimen with associated set of requirements.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "OM4"
},
{
"identity" : "rim",
"map" : "Role[classCode=SPEC]"
}]
},
{
"id" : "SpecimenDefinition.url",
"path" : "SpecimenDefinition.url",
"short" : "Logical canonical URL to reference this SpecimenDefinition (globally unique)",
"definition" : "An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.",
"comment" : "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.",
"requirements" : "Allows the SpecimenDefinition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.identifier",
"path" : "SpecimenDefinition.identifier",
"short" : "Business identifier",
"definition" : "A business identifier assigned to this SpecimenDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.version",
"path" : "SpecimenDefinition.version",
"short" : "Business version of the SpecimenDefinition",
"definition" : "The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.",
"comment" : "There may be multiple different instances of a SpecimenDefinition that have the same identifier but different versions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.title",
"path" : "SpecimenDefinition.title",
"short" : "Name for this SpecimenDefinition (Human friendly)",
"definition" : "A short, descriptive, user-friendly title for the SpecimenDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.derivedFromCanonical",
"path" : "SpecimenDefinition.derivedFromCanonical",
"short" : "Based on FHIR definition of another SpecimenDefinition",
"definition" : "The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"]
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.derivedFromUri",
"path" : "SpecimenDefinition.derivedFromUri",
"short" : "Based on external definition",
"definition" : "The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.",
"requirements" : "Specimen definitions may be refinements of other definitions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.status",
"path" : "SpecimenDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The current state of theSpecimenDefinition.",
"comment" : "A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation\nUnknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
}],
"strength" : "required",
"description" : "Codes identifying the status of a SpecimenDefinition resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.5.0"
}
},
{
"id" : "SpecimenDefinition.experimental",
"path" : "SpecimenDefinition.experimental",
"short" : "If this SpecimenDefinition is not for real usage",
"definition" : "A flag to indicate that this SpecimenDefinition is not authored for genuine usage.",
"comment" : "Allows filtering of SpecimenDefinition that are appropriate for use vs. not.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true
},
{
"id" : "SpecimenDefinition.subject[x]",
"path" : "SpecimenDefinition.subject[x]",
"short" : "Type of subject for specimen collection",
"definition" : "A code or group definition that describes the intended subject from which this kind of specimen is to be collected.",
"comment" : "Examples: person, animal, device, water ….",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.date",
"path" : "SpecimenDefinition.date",
"short" : "Date status first applied",
"definition" : "For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.publisher",
"path" : "SpecimenDefinition.publisher",
"short" : "The name of the individual or organization that published the SpecimenDefinition",
"definition" : "Helps establish the \"authority/credibility\" of the SpecimenDefinition. May also allow for contact.",
"requirements" : "Usually an organization, but may be an individual. The publisher (or steward) of the SpecimenDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the SpecimenDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the SpecimenDefinition. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.contact",
"path" : "SpecimenDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.description",
"path" : "SpecimenDefinition.description",
"short" : "Natural language description of the SpecimenDefinition",
"definition" : "A free text natural language description of the SpecimenDefinition from the consumer's perspective.",
"comment" : "This description can be used to capture details such as why the SpecimenDefinition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "SpecimenDefinition.useContext",
"path" : "SpecimenDefinition.useContext",
"short" : "Content intends to support these contexts",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.",
"comment" : "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}]
},
{
"id" : "SpecimenDefinition.jurisdiction",
"path" : "SpecimenDefinition.jurisdiction",
"short" : "Intended jurisdiction for this SpecimenDefinition (if applicable)",
"definition" : "A jurisdiction in which the SpecimenDefinition is intended to be used.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
}],
"strength" : "extensible",
"description" : "Codes for country, country subdivision and region for indicating where a resource is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
{
"id" : "SpecimenDefinition.purpose",
"path" : "SpecimenDefinition.purpose",
"short" : "Why this SpecimenDefinition is defined",
"definition" : "Explains why this SpecimeDefinition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the SpecimenDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this SpecimenDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "SpecimenDefinition.copyright",
"path" : "SpecimenDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.",
"requirements" : "Consumers of the SpecimenDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "SpecimenDefinition.approvalDate",
"path" : "SpecimenDefinition.approvalDate",
"short" : "When SpecimenDefinition was approved by publisher",
"definition" : "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "SpecimenDefinition.lastReviewDate",
"path" : "SpecimenDefinition.lastReviewDate",
"short" : "The date on which the asset content was last reviewed",
"definition" : "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comment" : "If specified, this is usually after the approval date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "SpecimenDefinition.effectivePeriod",
"path" : "SpecimenDefinition.effectivePeriod",
"short" : "The effective date range for the SpecimenDefinition",
"definition" : "The period during which the SpecimenDefinition content was or is planned to be effective.",
"comment" : "The effective period for a SpecimenDefinition determines when the content is applicable for usage and is independent of publication and review dates.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.typeCollected",
"path" : "SpecimenDefinition.typeCollected",
"short" : "Kind of material to collect",
"definition" : "The kind of material to be collected.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CollectedSpecimenType"
}],
"strength" : "example",
"description" : "The type of the specimen to be collected.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-6"
}]
},
{
"id" : "SpecimenDefinition.patientPreparation",
"path" : "SpecimenDefinition.patientPreparation",
"short" : "Patient preparation for collection",
"definition" : "Preparation of the patient for specimen collection.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PreparePatient"
}],
"strength" : "example",
"description" : "Checks on the patient prior specimen collection.",
"valueSet" : "http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-37"
}]
},
{
"id" : "SpecimenDefinition.timeAspect",
"path" : "SpecimenDefinition.timeAspect",
"short" : "Time aspect for collection",
"definition" : "Time aspect of specimen collection (duration or offset).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "24 hour, 20' post charge"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "OM1-43, OM1-44"
}]
},
{
"id" : "SpecimenDefinition.collection",
"path" : "SpecimenDefinition.collection",
"short" : "Specimen collection procedure",
"definition" : "The action to be performed for collecting the specimen.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCollection"
}],
"strength" : "example",
"description" : "The action to collect a type of specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-collection"
}
},
{
"id" : "SpecimenDefinition.typeTested",
"path" : "SpecimenDefinition.typeTested",
"short" : "Specimen in container intended for testing by lab",
"definition" : "Specimen conditioned in a container as expected by the testing laboratory.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "SpecimenDefinition.typeTested.isDerived",
"path" : "SpecimenDefinition.typeTested.isDerived",
"short" : "Primary or secondary specimen",
"definition" : "Primary of secondary specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : false
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-2"
}]
},
{
"id" : "SpecimenDefinition.typeTested.type",
"path" : "SpecimenDefinition.typeTested.type",
"short" : "Type of intended specimen",
"definition" : "The kind of specimen conditioned for testing expected by lab.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IntendedSpecimenType"
}],
"strength" : "example",
"description" : "The type of specimen conditioned in a container for lab testing.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
}
},
{
"id" : "SpecimenDefinition.typeTested.preference",
"path" : "SpecimenDefinition.typeTested.preference",
"short" : "preferred | alternate",
"definition" : "The preference for this type of conditioned specimen.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "preferred, alternate"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainedPreference"
}],
"strength" : "required",
"description" : "Degree of preference of a type of conditioned specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.5.0"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-16"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container",
"path" : "SpecimenDefinition.typeTested.container",
"short" : "The specimen's container",
"definition" : "The specimen's container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.material",
"path" : "SpecimenDefinition.typeTested.container.material",
"short" : "The material type used for the container",
"definition" : "The type of material of the container.",
"comment" : "Examples: glass, plastic, metal.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerMaterial"
}],
"strength" : "example",
"description" : "Types of material for specimen containers.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-material"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.type",
"path" : "SpecimenDefinition.typeTested.container.type",
"short" : "Kind of container associated with the kind of specimen",
"definition" : "The type of container used to contain this kind of specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerType"
}],
"strength" : "example",
"description" : "Type of specimen container.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.cap",
"path" : "SpecimenDefinition.typeTested.container.cap",
"short" : "Color of container cap",
"definition" : "Color of container cap.",
"requirements" : "From ISO 6710-2017 Table F.1 Recommended colour codes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerCap"
}],
"strength" : "example",
"description" : "Color of the container cap.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-cap"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.description",
"path" : "SpecimenDefinition.typeTested.container.description",
"short" : "The description of the kind of container",
"definition" : "The textual description of the kind of container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "Blue top tube with citrate"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-3"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.capacity",
"path" : "SpecimenDefinition.typeTested.container.capacity",
"short" : "The capacity of this kind of container",
"definition" : "The capacity (volume or other measure) of this kind of container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-4, OM4-5"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"path" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"short" : "Minimum volume",
"definition" : "The minimum volume to be conditioned in the container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-11"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive",
"path" : "SpecimenDefinition.typeTested.container.additive",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"path" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerAdditive"
}],
"strength" : "example",
"description" : "Substance added to specimen container.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0371"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.preparation",
"path" : "SpecimenDefinition.typeTested.container.preparation",
"short" : "Special processing applied to the container for this specimen type",
"definition" : "Special processing that should be applied to the container for this kind of specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-8"
}]
},
{
"id" : "SpecimenDefinition.typeTested.requirement",
"path" : "SpecimenDefinition.typeTested.requirement",
"short" : "Requirements for specimen delivery and special handling",
"definition" : "Requirements for delivery and special handling of this kind of conditioned specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-12"
}]
},
{
"id" : "SpecimenDefinition.typeTested.retentionTime",
"path" : "SpecimenDefinition.typeTested.retentionTime",
"short" : "The usual time for retaining this kind of specimen",
"definition" : "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-14"
}]
},
{
"id" : "SpecimenDefinition.typeTested.singleUse",
"path" : "SpecimenDefinition.typeTested.singleUse",
"short" : "Specimen for single use only",
"definition" : "Specimen can be used by only one test or panel if the value is \"true\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "SpecimenDefinition.typeTested.rejectionCriterion",
"path" : "SpecimenDefinition.typeTested.rejectionCriterion",
"short" : "Criterion specified for specimen rejection",
"definition" : "Criterion for rejection of the specimen in its container by the laboratory.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RejectionCriterion"
}],
"strength" : "example",
"description" : "Criterion for rejection of the specimen by laboratory.",
"valueSet" : "http://hl7.org/fhir/ValueSet/rejection-criteria"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-39"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling",
"path" : "SpecimenDefinition.typeTested.handling",
"short" : "Specimen handling before testing",
"definition" : "Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"path" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"short" : "Qualifies the interval of temperature",
"definition" : "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "HandlingConditionSet"
}],
"strength" : "example",
"description" : "Set of handling instructions prior testing of the specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/handling-condition"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-15"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"path" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"short" : "Temperature range for these handling instructions",
"definition" : "The temperature interval for this set of handling instructions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.maxDuration",
"path" : "SpecimenDefinition.typeTested.handling.maxDuration",
"short" : "Maximum preservation time",
"definition" : "The maximum time interval of preservation of the specimen with these conditions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.instruction",
"path" : "SpecimenDefinition.typeTested.handling.instruction",
"short" : "Preservation instruction",
"definition" : "Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "freeze within 4 hours"
}]
},
{
"id" : "SpecimenDefinition.typeTested.testingDestination",
"path" : "SpecimenDefinition.typeTested.testingDestination",
"short" : "Where the specimen will be tested",
"definition" : "Where the specimen will be tested: e.g., lab, sector, device or any combination of these.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestingDestination"
}],
"strength" : "example",
"description" : "Codes specifying where the specimen will be tested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/diagnostic-service-sections"
}
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:46+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change