Release 5
AdministrationThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. 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: 1 | Trial Use | Security Category: Anonymous | Compartments: No defined compartments |
A kind of specimen with associated set of requirements.
SpecimenDefinition will define a kind of specimen, which can be associated with in vitro diagnostic procedures described in a catalog of orderable services. SpecimenDefinition describes the kind of specimen to be collected from the subject of these procedures as well as the requirements applying to the collection activity, the preparation of the subject for this collection. This resource also describes the associated type(s) of specimen conditioned for testing, which are the output of the specimen collection activity. A specimen conditioned for testing is described with the type(s) of container and possible additive to be used, the minimal and normal volumes of collection, the conditions of storage, transportation and handling for the specimen once collected and conditioned. This resource is a necessary building block of a sharable catalog of orderable in vitro diagnostic services. The subjects of these orderable services may be human patients, non-human living subjects or non-living materials such as water, surfaces, medical devices, etc. All sub-specialties of clinical and anatomic pathology laboratories are concerned, as well as all care services prone to order in vitro diagnostic services to those laboratories. A catalog of orderable services generally belongs to a specific laboratory or facility. Nonetheless, the data items used to build this catalog are of universal meaning and interest.
This resource relates to these other resources:
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  SpecimenDefinition | TU | DomainResource | Kind of specimen Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
  url | Σ | 0..1 | uri | Logical canonical URL to reference this SpecimenDefinition (globally unique) |
 identifier | Σ | 0..1 | Identifier | Business identifier |
| version | Σ | 0..1 | string | Business version of the SpecimenDefinition |
  versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
 versionAlgorithmString | string | |||
 versionAlgorithmCoding | Coding | |||
| name | Σ | 0..1 | string | Name for this {{title}} (computer friendly) |
| title | ΣT | 0..1 | string | Name for this SpecimenDefinition (Human friendly) |
 derivedFromCanonical | Σ | 0..* | canonical(SpecimenDefinition) | Based on FHIR definition of another SpecimenDefinition |
| derivedFromUri | Σ | 0..* | uri | Based on external definition |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
| experimental | Σ | 0..1 | boolean | If this SpecimenDefinition is not for real usage |
| subject[x] | Σ | 0..1 | Type of subject for specimen collection | |
| subjectCodeableConcept | CodeableConcept | |||
| subjectReference | Reference(Group) | |||
| date | Σ | 0..1 | dateTime | Date status first applied |
| publisher | ΣT | 0..1 | string | The name of the individual or organization that published the SpecimenDefinition |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | T | 0..1 | markdown | Natural language description of the SpecimenDefinition |
| useContext | 0..* | UsageContext | Content intends to support these contexts | |
| jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for this SpecimenDefinition (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
| purpose | T | 0..1 | markdown | Why this SpecimenDefinition is defined |
| copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
| copyrightLabel | T | 0..1 | string | Copyright holder and year(s) |
| approvalDate | 0..1 | date | When SpecimenDefinition was approved by publisher | |
| lastReviewDate | 0..1 | date | The date on which the asset content was last reviewed by the publisher | |
| effectivePeriod | Σ | 0..1 | Period | The effective date range for the SpecimenDefinition |
| typeCollected | Σ | 0..1 | CodeableConcept | Kind of material to collect Binding: hl7VS-specimenType (Example) |
| patientPreparation | Σ | 0..* | CodeableConcept | Patient preparation for collection Binding: Patient preparation prior specimen collection (Example) |
| timeAspect | Σ | 0..1 | string | Time aspect for collection |
| collection | Σ | 0..* | CodeableConcept | Specimen collection procedure Binding: Specimen collection methods (Example) |
  typeTested | 0..* | BackboneElement | Specimen in container intended for testing by lab | |
 isDerived | 0..1 | boolean | Primary or secondary specimen | |
| type | 0..1 | CodeableConcept | Type of intended specimen Binding: hl7VS-specimenType (Example) | |
| preference | 1..1 | code | preferred | alternate Binding: Specimen Contained Preference (Required) | |
| container | 0..1 | BackboneElement | The specimen's container | |
| material | 0..1 | CodeableConcept | The material type used for the container Binding: Types of material for specimen containers (Example) | |
| type | 0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: Specimen Container Type (Example) | |
| cap | 0..1 | CodeableConcept | Color of container cap Binding: Container Cap (Example) | |
| description | 0..1 | markdown | The description of the kind of container | |
| capacity | 0..1 | SimpleQuantity | The capacity of this kind of container | |
| minimumVolume[x] | 0..1 | Minimum volume | ||
| minimumVolumeQuantity | SimpleQuantity | |||
| minimumVolumeString | string | |||
| additive | 0..* | BackboneElement | Additive associated with container | |
| additive[x] | 1..1 | Additive associated with container Binding: hl7VS-additivePreservative (Example) | ||
| additiveCodeableConcept | CodeableConcept | |||
| additiveReference | Reference(SubstanceDefinition) | |||
| preparation | 0..1 | markdown | Special processing applied to the container for this specimen type | |
| requirement | 0..1 | markdown | Requirements for specimen delivery and special handling | |
| retentionTime | 0..1 | Duration | The usual time for retaining this kind of specimen | |
| singleUse | 0..1 | boolean | Specimen for single use only | |
| rejectionCriterion | 0..* | CodeableConcept | Criterion specified for specimen rejection Binding: Rejection Criterion (Example) | |
| handling | 0..* | BackboneElement | Specimen handling before testing | |
| temperatureQualifier | 0..1 | CodeableConcept | Qualifies the interval of temperature Binding: Handling Condition Set (Example) | |
| temperatureRange | 0..1 | Range | Temperature range for these handling instructions | |
| maxDuration | 0..1 | Duration | Maximum preservation time | |
| instruction | 0..1 | markdown | Preservation instruction | |
| testingDestination | 0..* | CodeableConcept | Where the specimen will be tested Binding: Diagnostic Service Section Codes (Example) | |
| Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<SpecimenDefinition xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical canonical URL to reference this SpecimenDefinition (globally unique) --> <identifier><!-- 0..1 Identifier Business identifier --></identifier> <version value="[string]"/><!-- 0..1 Business version of the SpecimenDefinition --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- 0..1 Name for this {{title}} (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this SpecimenDefinition (Human friendly) --> <derivedFromCanonical><!-- 0..* canonical(SpecimenDefinition) Based on FHIR definition of another SpecimenDefinition --></derivedFromCanonical> <derivedFromUri value="[uri]"/><!-- 0..* Based on external definition --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 If this SpecimenDefinition is not for real usage --> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of subject for specimen collection --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date status first applied --> <publisher value="[string]"/><!-- 0..1 The name of the individual or organization that published the SpecimenDefinition --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the SpecimenDefinition --> <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for this SpecimenDefinition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this SpecimenDefinition is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When SpecimenDefinition was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 The date on which the asset content was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period The effective date range for the SpecimenDefinition --></effectivePeriod> <typeCollected><!-- 0..1 CodeableConcept Kind of material to collect
JSON Template
{
"resourceType" : "SpecimenDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical canonical URL to reference this SpecimenDefinition (globally unique)
"identifier" : { Identifier }, // Business identifier
"version" : "<string>", // Business version of the SpecimenDefinition
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // Name for this {{title}} (computer friendly)
"title" : "<string>", // Name for this SpecimenDefinition (Human friendly)
"derivedFromCanonical" : ["<canonical(SpecimenDefinition)>"], // Based on FHIR definition of another SpecimenDefinition
"derivedFromUri" : ["<uri>"], // Based on external definition
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // If this SpecimenDefinition is not for real usage
// subject[x]: Type of subject for specimen collection. One of these 2:
"subjectCodeableConcept" : { CodeableConcept },
"subjectReference" : { Reference(Group) },
"date" : "<dateTime>", // Date status first applied
"publisher" : "<string>", // The name of the individual or organization that published the SpecimenDefinition
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the SpecimenDefinition
"useContext" : [{ UsageContext }], // Content intends to support these contexts
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for this SpecimenDefinition (if applicable)
"purpose" : "<markdown>", // Why this SpecimenDefinition is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When SpecimenDefinition was approved by publisher
"lastReviewDate" : "<date>", // The date on which the asset content was last reviewed by the publisher
"effectivePeriod" : { Period }, // The effective date range for the SpecimenDefinition
"typeCollected" : { CodeableConcept }, // Kind of material to collect
"patientPreparation" : [{ CodeableConcept }], // Patient preparation for collection
"timeAspect" : "<string>", // Time aspect for collection
"collection" : [{ CodeableConcept }], // Specimen collection procedure
"typeTested" : [{ // Specimen in container intended for testing by lab
"isDerived" : <boolean>, // Primary or secondary specimen
"type" : { CodeableConcept }, // Type of intended specimen
"preference" : "<code>", // R! preferred | alternate
"container" : { // The specimen's container
"material" : { CodeableConcept }, // The material type used for the container
"type" : { CodeableConcept }, // Kind of container associated with the kind of specimen
"cap" : { CodeableConcept }, // Color of container cap
"description" : "<markdown>", // The description of the kind of container
"capacity" : { Quantity(SimpleQuantity) }, // The capacity of this kind of container
// minimumVolume[x]: Minimum volume. One of these 2:
"minimumVolumeQuantity" : { Quantity(SimpleQuantity) },
"minimumVolumeString" : "<string>",
"additive" : [{ // Additive associated with container
// additive[x]: Additive associated with container. One of these 2:
"additiveCodeableConcept" : { CodeableConcept },
"additiveReference" : { Reference(SubstanceDefinition) }
}],
"preparation" : "<markdown>" // Special processing applied to the container for this specimen type
},
"requirement" : "<markdown>", // Requirements for specimen delivery and special handling
"retentionTime" : { Duration }, // The usual time for retaining this kind of specimen
"singleUse" : <boolean>, // Specimen for single use only
"rejectionCriterion" : [{ CodeableConcept }], // Criterion specified for specimen rejection
"handling" : [{ // Specimen handling before testing
"temperatureQualifier" : { CodeableConcept }, // Qualifies the interval of temperature
"temperatureRange" : { Range }, // Temperature range for these handling instructions
"maxDuration" : { Duration }, // Maximum preservation time
"instruction" : "<markdown>" // Preservation instruction
}],
"testingDestination" : [{ CodeableConcept }] // Where the specimen will be tested
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes from both R4 and R4B
| SpecimenDefinition | |
| SpecimenDefinition.url |
|
| SpecimenDefinition.version |
|
| SpecimenDefinition.versionAlgorithm[x] |
|
| SpecimenDefinition.name |
|
| SpecimenDefinition.title |
|
| SpecimenDefinition.derivedFromCanonical |
|
| SpecimenDefinition.derivedFromUri |
|
| SpecimenDefinition.status |
|
| SpecimenDefinition.experimental |
|
| SpecimenDefinition.subject[x] |
|
| SpecimenDefinition.date |
|
| SpecimenDefinition.publisher |
|
| SpecimenDefinition.contact |
|
| SpecimenDefinition.description |
|
| SpecimenDefinition.useContext |
|
| SpecimenDefinition.jurisdiction |
|
| SpecimenDefinition.purpose |
|
| SpecimenDefinition.copyright |
|
| SpecimenDefinition.copyrightLabel |
|
| SpecimenDefinition.approvalDate |
|
| SpecimenDefinition.lastReviewDate |
|
| SpecimenDefinition.effectivePeriod |
|
| SpecimenDefinition.typeTested.container.description |
|
| SpecimenDefinition.typeTested.container.preparation |
|
| SpecimenDefinition.typeTested.requirement |
|
| SpecimenDefinition.typeTested.singleUse |
|
| SpecimenDefinition.typeTested.handling.instruction |
|
| SpecimenDefinition.typeTested.testingDestination |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SpecimenDefinition | TU | DomainResource | Kind of specimen Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
| url | Σ | 0..1 | uri | Logical canonical URL to reference this SpecimenDefinition (globally unique) |
| identifier | Σ | 0..1 | Identifier | Business identifier |
| version | Σ | 0..1 | string | Business version of the SpecimenDefinition |
| versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
| versionAlgorithmString | string | |||
| versionAlgorithmCoding | Coding | |||
| name | Σ | 0..1 | string | Name for this {{title}} (computer friendly) |
| title | ΣT | 0..1 | string | Name for this SpecimenDefinition (Human friendly) |
| derivedFromCanonical | Σ | 0..* | canonical(SpecimenDefinition) | Based on FHIR definition of another SpecimenDefinition |
| derivedFromUri | Σ | 0..* | uri | Based on external definition |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
| experimental | Σ | 0..1 | boolean | If this SpecimenDefinition is not for real usage |
| subject[x] | Σ | 0..1 | Type of subject for specimen collection | |
| subjectCodeableConcept | CodeableConcept | |||
| subjectReference | Reference(Group) | |||
| date | Σ | 0..1 | dateTime | Date status first applied |
| publisher | ΣT | 0..1 | string | The name of the individual or organization that published the SpecimenDefinition |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | T | 0..1 | markdown | Natural language description of the SpecimenDefinition |
| useContext | 0..* | UsageContext | Content intends to support these contexts | |
| jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for this SpecimenDefinition (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
| purpose | T | 0..1 | markdown | Why this SpecimenDefinition is defined |
| copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
| copyrightLabel | T | 0..1 | string | Copyright holder and year(s) |
| approvalDate | 0..1 | date | When SpecimenDefinition was approved by publisher | |
| lastReviewDate | 0..1 | date | The date on which the asset content was last reviewed by the publisher | |
| effectivePeriod | Σ | 0..1 | Period | The effective date range for the SpecimenDefinition |
| typeCollected | Σ | 0..1 | CodeableConcept | Kind of material to collect Binding: hl7VS-specimenType (Example) |
| patientPreparation | Σ | 0..* | CodeableConcept | Patient preparation for collection Binding: Patient preparation prior specimen collection (Example) |
| timeAspect | Σ | 0..1 | string | Time aspect for collection |
| collection | Σ | 0..* | CodeableConcept | Specimen collection procedure Binding: Specimen collection methods (Example) |
| typeTested | 0..* | BackboneElement | Specimen in container intended for testing by lab | |
| isDerived | 0..1 | boolean | Primary or secondary specimen | |
| type | 0..1 | CodeableConcept | Type of intended specimen Binding: hl7VS-specimenType (Example) | |
| preference | 1..1 | code | preferred | alternate Binding: Specimen Contained Preference (Required) | |
| container | 0..1 | BackboneElement | The specimen's container | |
| material | 0..1 | CodeableConcept | The material type used for the container Binding: Types of material for specimen containers (Example) | |
| type | 0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: Specimen Container Type (Example) | |
| cap | 0..1 | CodeableConcept | Color of container cap Binding: Container Cap (Example) | |
| description | 0..1 | markdown | The description of the kind of container | |
| capacity | 0..1 | SimpleQuantity | The capacity of this kind of container | |
| minimumVolume[x] | 0..1 | Minimum volume | ||
| minimumVolumeQuantity | SimpleQuantity | |||
| minimumVolumeString | string | |||
| additive | 0..* | BackboneElement | Additive associated with container | |
| additive[x] | 1..1 | Additive associated with container Binding: hl7VS-additivePreservative (Example) | ||
| additiveCodeableConcept | CodeableConcept | |||
| additiveReference | Reference(SubstanceDefinition) | |||
| preparation | 0..1 | markdown | Special processing applied to the container for this specimen type | |
| requirement | 0..1 | markdown | Requirements for specimen delivery and special handling | |
| retentionTime | 0..1 | Duration | The usual time for retaining this kind of specimen | |
| singleUse | 0..1 | boolean | Specimen for single use only | |
| rejectionCriterion | 0..* | CodeableConcept | Criterion specified for specimen rejection Binding: Rejection Criterion (Example) | |
| handling | 0..* | BackboneElement | Specimen handling before testing | |
| temperatureQualifier | 0..1 | CodeableConcept | Qualifies the interval of temperature Binding: Handling Condition Set (Example) | |
| temperatureRange | 0..1 | Range | Temperature range for these handling instructions | |
| maxDuration | 0..1 | Duration | Maximum preservation time | |
| instruction | 0..1 | markdown | Preservation instruction | |
| testingDestination | 0..* | CodeableConcept | Where the specimen will be tested Binding: Diagnostic Service Section Codes (Example) | |
| Documentation for this format |
See the Extensions for this resource
XML Template
<SpecimenDefinition xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "SpecimenDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical canonical URL to reference this SpecimenDefinition (globally unique)
"identifier" : { Identifier }, // Business identifier
"version" : "<string>", // Business version of the SpecimenDefinition
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // Name for this {{title}} (computer friendly)
"title" : "<string>", // Name for this SpecimenDefinition (Human friendly)
"derivedFromCanonical" : ["<canonical(SpecimenDefinition)>"], // Based on FHIR definition of another SpecimenDefinition
"derivedFromUri" : ["<uri>"], // Based on external definition
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // If this SpecimenDefinition is not for real usage
// subject[x]: Type of subject for specimen collection. One of these 2:
"subjectCodeableConcept" : { CodeableConcept },
"subjectReference" : { Reference(Group) },
"date" : "<dateTime>", // Date status first applied
"publisher" : "<string>", // The name of the individual or organization that published the SpecimenDefinition
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the SpecimenDefinition
"useContext" : [{ UsageContext }], // Content intends to support these contexts
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for this SpecimenDefinition (if applicable)
"purpose" : "<markdown>", // Why this SpecimenDefinition is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When SpecimenDefinition was approved by publisher
"lastReviewDate" : "<date>", // The date on which the asset content was last reviewed by the publisher
"effectivePeriod" : { Period }, // The effective date range for the SpecimenDefinition
"typeCollected" : { CodeableConcept }, // Kind of material to collect
"patientPreparation" : [{ CodeableConcept }], // Patient preparation for collection
"timeAspect" : "<string>", // Time aspect for collection
"collection" : [{ CodeableConcept }], // Specimen collection procedure
"typeTested" : [{ // Specimen in container intended for testing by lab
"isDerived" : <boolean>, // Primary or secondary specimen
"type" : { CodeableConcept }, // Type of intended specimen
"preference" : "<code>", // R! preferred | alternate
"container" : { // The specimen's container
"material" : { CodeableConcept }, // The material type used for the container
"type" : { CodeableConcept }, // Kind of container associated with the kind of specimen
"cap" : { CodeableConcept }, // Color of container cap
"description" : "<markdown>", // The description of the kind of container
"capacity" : { Quantity(SimpleQuantity) }, // The capacity of this kind of container
// minimumVolume[x]: Minimum volume. One of these 2:
"minimumVolumeQuantity" : { Quantity(SimpleQuantity) },
"minimumVolumeString" : "<string>",
"additive" : [{ // Additive associated with container
// additive[x]: Additive associated with container. One of these 2:
"additiveCodeableConcept" : { CodeableConcept },
"additiveReference" : { Reference(SubstanceDefinition) }
}],
"preparation" : "<markdown>" // Special processing applied to the container for this specimen type
},
"requirement" : "<markdown>", // Requirements for specimen delivery and special handling
"retentionTime" : { Duration }, // The usual time for retaining this kind of specimen
"singleUse" : <boolean>, // Specimen for single use only
"rejectionCriterion" : [{ CodeableConcept }], // Criterion specified for specimen rejection
"handling" : [{ // Specimen handling before testing
"temperatureQualifier" : { CodeableConcept }, // Qualifies the interval of temperature
"temperatureRange" : { Range }, // Temperature range for these handling instructions
"maxDuration" : { Duration }, // Maximum preservation time
"instruction" : "<markdown>" // Preservation instruction
}],
"testingDestination" : [{ CodeableConcept }] // Where the specimen will be tested
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes from both R4 and R4B
| SpecimenDefinition | |
| SpecimenDefinition.url |
|
| SpecimenDefinition.version |
|
| SpecimenDefinition.versionAlgorithm[x] |
|
| SpecimenDefinition.name |
|
| SpecimenDefinition.title |
|
| SpecimenDefinition.derivedFromCanonical |
|
| SpecimenDefinition.derivedFromUri |
|
| SpecimenDefinition.status |
|
| SpecimenDefinition.experimental |
|
| SpecimenDefinition.subject[x] |
|
| SpecimenDefinition.date |
|
| SpecimenDefinition.publisher |
|
| SpecimenDefinition.contact |
|
| SpecimenDefinition.description |
|
| SpecimenDefinition.useContext |
|
| SpecimenDefinition.jurisdiction |
|
| SpecimenDefinition.purpose |
|
| SpecimenDefinition.copyright |
|
| SpecimenDefinition.copyrightLabel |
|
| SpecimenDefinition.approvalDate |
|
| SpecimenDefinition.lastReviewDate |
|
| SpecimenDefinition.effectivePeriod |
|
| SpecimenDefinition.typeTested.container.description |
|
| SpecimenDefinition.typeTested.container.preparation |
|
| SpecimenDefinition.typeTested.requirement |
|
| SpecimenDefinition.typeTested.singleUse |
|
| SpecimenDefinition.typeTested.handling.instruction |
|
| SpecimenDefinition.typeTested.testingDestination |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| SpecimenDefinition.versionAlgorithm[x] | VersionAlgorithm | Extensible | Indicates the mechanism used to compare versions to determine which is more current. |
| SpecimenDefinition.status | PublicationStatus | Required | The lifecycle status of an artifact. |
| SpecimenDefinition.jurisdiction | JurisdictionValueSet | Extensible | This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used. Note: The codes for countries and country subdivisions are taken from ISO 3166 |
| SpecimenDefinition.typeCollected | Hl7VSSpecimenType (a valid code from specimenType ) | Example | Concepts that describe the precise nature of an entity that may be used as the source material for an observation. This is one of two code systems that are used instead of table 0070 (code system xxxx) which conflated specimen types and specimen collection methods. Used in Version 2 messaging in the SPM segment. |
| SpecimenDefinition.patientPreparation | PreparePatient | Example | Checks on the patient prior specimen collection. All SNOMED CT concepts descendants of 703763000 |Precondition value (qualifier value)| |
| SpecimenDefinition.collection | SpecimenCollection | Example | Actions that can be taken for the collection of specimen from a subject. |
| SpecimenDefinition.typeTested.type | Hl7VSSpecimenType (a valid code from specimenType ) | Example | Concepts that describe the precise nature of an entity that may be used as the source material for an observation. This is one of two code systems that are used instead of table 0070 (code system xxxx) which conflated specimen types and specimen collection methods. Used in Version 2 messaging in the SPM segment. |
| SpecimenDefinition.typeTested.preference | SpecimenContainedPreference | Required | Degree of preference of a type of conditioned specimen. |
| SpecimenDefinition.typeTested.container.material | ContainerMaterials | Example | This value set includes SNOMED CT codes for materials that specimen containers are made of |
| SpecimenDefinition.typeTested.container.type | SpecimenContainerType | Example | Checks on the patient prior specimen collection. All SNOMED CT concepts descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)| |
| SpecimenDefinition.typeTested.container.cap | ContainerCap | Example | Color of the container cap. |
| SpecimenDefinition.typeTested.container.additive.additive[x] | Hl7VSAdditivePreservative (a valid code from additivePreservative ) | Example | Concepts specifying any additive introduced to the specimen before or at the time of collection. These additives may be introduced in order to preserve, maintain or enhance the particular nature or component of the specimen. Used in Version 2 messaging in the SPM segment. |
| SpecimenDefinition.typeTested.rejectionCriterion | RejectionCriterion | Example | Criterion for rejection of the specimen by laboratory. |
| SpecimenDefinition.typeTested.handling.temperatureQualifier | HandlingConditionSet | Example | Set of handling instructions prior testing of the specimen. |
| SpecimenDefinition.typeTested.testingDestination | DiagnosticServiceSectionCodes (a valid code from diagnosticServiceSectionId ) | Example | This value set includes all the codes in HL7 V2 table 0074. |
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| container | token | The type of specimen conditioned in container expected by the lab | SpecimenDefinition.typeTested.container.type | |
| experimental | token | Not for genuine usage (true) | SpecimenDefinition.experimental | |
| identifier | token | The unique identifier associated with the SpecimenDefinition | SpecimenDefinition.identifier | 34 Resources |
| is-derived | token | Primary specimen (false) or derived specimen (true) | SpecimenDefinition.typeTested.isDerived | |
| status | token | Publication status of the SpecimenDefinition: draft, active, retired, unknown | SpecimenDefinition.status | 35 Resources |
| title | string | Human-friendly name of the SpecimenDefinition | SpecimenDefinition.title | 27 Resources |
| type | token | The type of collected specimen | SpecimenDefinition.typeCollected | |
| type-tested | token | The type of specimen conditioned for testing | SpecimenDefinition.typeTested.type | |
| url | uri | The uri that identifies the specimen definition | SpecimenDefinition.url | 34 Resources |
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:26+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change