R4 Ballot #1 (Mixed Normative/Trial use) Current Build
This page was published as part of FHIR v3.3.0: R4 Ballot #1 : Mixed Normative/Trial use (First Normative ballot). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .

10.8 Resource SpecimenDefinition - Content

Orders and Observations Work Group Maturity Level : 0   Trial Use Security Category : Anonymous Compartments : Not linked to any 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 ... devices, etc. All sub-specialties of clinical and anatomic pathology latoratories 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:

  • The SpecimenDefinition resource is referenced by the resource CatalogEntry, when it carries the definition of an in vitro diagnostic testing activity.
  • The SpecimenDefinition resource is referenced by the Catalog resource, which represents a whole catalog, to enable the creation and maintenance of kinds of specimens within a catalog of orderable diagnostic services.
  • The SpecimenDefinition resource references the Substance resource, in order to describe the type of substance (body fluid, other material) concerned by a kind of specimen. It also references the Substance resource to describe additives to be used in the production of specimens of some kind.

This resource is referenced by ActivityDefinition and EntryDefinition CatalogEntry .

This resource does not implement any patterns.

Structure

lightExposure 0..1 string Light exposure
Name Flags Card. Type Description & Constraints doco
. . SpecimenDefinition TU DomainResource Kind of specimen
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..1 Identifier Business identifier of a kind of specimen
. . . typeCollected Σ 0..1 CodeableConcept Kind of material to collect
v2 Specimen Type ( Example )
. . . patientPreparation Σ 0..1 0..* string CodeableConcept Patient preparation for collection
Patient preparation prior specimen collection ( Example )
. . . timeAspect Σ 0..1 string Time aspect for collection
. . . collection Σ 0..* CodeableConcept Specimen collection procedure
Specimen collection methods ( Example )
. . . specimenToLab typeTested 0..* BackboneElement Specimen in container intended for testing by lab
. . . . isDerived 1..1 0..1 boolean Primary or secondary specimen
. . . . type 0..1 CodeableConcept Type of intended specimen
v2 Specimen Type ( Example )
. . . . preference 1..1 code preferred | alternate
SpecimenContainedPreference ( Required )
. . . . container 0..1 BackboneElement The specimen's container
. . . . . containerMaterial material 0..1 CodeableConcept Container material
Types of material for specimen containers ( Example )
. . . . . containerType type 0..1 CodeableConcept Kind of container associated with the kind of specimen
LOINC Codes for Cholesterol in Serum/Plasma Specimen Container Type ( Example )
. . . . . containerCap cap 0..1 CodeableConcept Color of container cap
ContainerCap ( Example )
. . . . . containerDescription description 0..1 string Container description
. . . . . containerCapacity capacity 0..1 SimpleQuantity Container capacity
. . . . containerMinimumVolume . minimumVolume[x] 0..1 Minimum volume
...... minimumVolumeQuantity SimpleQuantity Minimum volume
. . . . . . minimumVolumeString string
... . . containerAdditive additive 0..* BackboneElement Additive associated with container
. . . . . . additive[x] 1..1 Additive associated with container
v2 Additive/Preservative Additive ( Example )
. . . . . . . additiveCodeableConcept CodeableConcept
. . . . . . . additiveReference Reference ( Substance )
. . . . . containerPreparation preparation 0..1 string Specimen container preparation
. . . . requirement 0..1 string Specimen requirements
. . . . retentionTime 0..1 Duration Specimen retention time
. . . . rejectionCriterion 0..* CodeableConcept Rejection criterion
RejectionCriterion ( Example )
. . . . handling 0..* BackboneElement Specimen handling before testing
. . . . . conditionSet temperatureQualifier 0..1 CodeableConcept Conservation condition set Temperature qualifier
HandlingConditionSet ( Example )
. . . . . tempRange temperatureRange 0..1 Range Temperature range
. . . . . maxDuration 0..1 Duration Maximum conservation preservation time
. . . . . instruction 0..1 string Conservation Preservation instruction

doco Documentation for this format

UML Diagram ( Legend )

SpecimenDefinition ( DomainResource ) A business identifier associated with the kind of specimen identifier : Identifier [0..1] The kind of material to be collected typeCollected : CodeableConcept [0..1] « The type of the specimen to be collected. (Strength=Example) v2 Specimen Type v2.0487 ?? » Preparation of the patient for specimen collection patientPreparation : string CodeableConcept [0..1] [0..*] « Checks on the patient prior specimen collection. (Strength=Example) PreparePatient ?? » Time aspect of specimen collection (duration or offset) timeAspect : string [0..1] The action to be performed for collecting the specimen collection : CodeableConcept [0..*] « The action to collect a type of specimen. (Strength=Example) SpecimenCollection ?? » SpecimenToLab TypeTested Primary of secondary specimen isDerived : boolean [1..1] [0..1] The kind of specimen conditioned for testing expected by lab type : CodeableConcept [0..1] « The type of specimen conditioned in a container for lab testing testing. (Strength=Example) v2 Specimen Type v2.0487 ?? » The preference for this type of conditioned specimen preference : code [1..1] « Degree of preference of a type of conditioned specimen specimen. (Strength=Required) SpecimenContainedPreference ! » Requirements for delivery and special handling of this kind of conditioned specimen requirement : string [0..1] The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing retentionTime : Duration [0..1] Criterion for rejection of the specimen in its container by the laboratory rejectionCriterion : CodeableConcept [0..*] « Criterion for rejection of the specimen by laboratory. (Strength=Example) RejectionCriterion ?? » Container The type of material of the container containerMaterial material : CodeableConcept [0..1] « Types of material for specimen containers. (Strength=Example) ContainerMaterials ?? » The type of container used to contain this kind of specimen containerType type : CodeableConcept [0..1] « Type of specimen container container. (Strength=Example) LOINC Codes for Cholesterol i... SpecimenContainerType ?? » Color of container cap containerCap cap : CodeableConcept [0..1] « Color of the container cap cap. (Strength=Example) ContainerCap ?? » The textual description of the kind of container containerDescription description : string [0..1] The capacity (volume or other measure) of this kind of container containerCapacity capacity : Quantity ( SimpleQuantity ) [0..1] The minimum volume to be conditioned in the container containerMinimumVolume minimumVolume[x] : Type [0..1] « Quantity ( SimpleQuantity ) [0..1] )| string » Special processing that should be applied to the container for this kind of specimen containerPreparation : string [0..1] Requirements for delivery and special handling of this kind of conditioned specimen requirement preparation : string [0..1] The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing retentionTime : Duration [0..1] Criterion for rejection of the specimen in its container by the laboratory rejectionCriterion : CodeableConcept [0..*] « Criterion for rejection of the specimen by laboratory (Strength=Example) RejectionCriterion ?? » ContainerAdditive Additive Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA additive[x] : Type [1..1] « CodeableConcept | Reference ( Substance ); Substance added to specimen container container. (Strength=Example) v2 Additive/Preservative v2.0371 ?? » Handling Code representing It qualifies the set interval of handling instructions temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element conditionSet temperatureQualifier : CodeableConcept [0..1] « Set of handling instructions prior testing of the specimen specimen. (Strength=Example) HandlingConditionSet ?? » The temperature interval for this set of handling instructions tempRange temperatureRange : Range [0..1] The maximum time interval of conservation preservation of the specimen with these conditions maxDuration : Duration [0..1] Textual instructions regarding the light exposure of the specimen prior testing lightExposure : string [0..1] Additional textual instructions for the conservation preservation or transport of the specimen specimen. For instance, 'Protect from light exposure' instruction : string [0..1] Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA containerAdditive additive [0..*] The specimen's container container [0..1] Set of instructions for conservation/transport preservation/transport of the specimen at a defined temperature interval, prior the testing process handling [0..*] Specimen conditioned in a container as expected by the testing laboratory specimenToLab typeTested [0..*]

XML Template

<SpecimenDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business identifier of a kind of specimen --></identifier>
 <typeCollected><!-- 0..1 CodeableConcept Kind of material to collect --></typeCollected>
 <

 <patientPreparation><!-- 0..* CodeableConcept Patient preparation for collection --></patientPreparation>

 <timeAspect value="[string]"/><!-- 0..1 Time aspect for collection -->
 <</collection>
 <
  <
  <</type>
  <
  <</containerMaterial>
  <</containerType>
  <</containerCap>
  <
  <</containerCapacity>
  <</containerMinimumVolume>
  <
   <</additive[x]>
  </containerAdditive>
  <
  <
  <</retentionTime>
  <</rejectionCriterion>
  <
   <</conditionSet>
   <</tempRange>
   <</maxDuration>
   <
   <

 <collection><!-- 0..* CodeableConcept Specimen collection procedure --></collection>
 <typeTested>  <!-- 0..* Specimen in container intended for testing by lab -->
  <isDerived value="[boolean]"/><!-- 0..1 Primary or secondary specimen -->
  <type><!-- 0..1 CodeableConcept Type of intended specimen --></type>
  <preference value="[code]"/><!-- 1..1 preferred | alternate -->
  <container>  <!-- 0..1 The specimen's container -->
   <material><!-- 0..1 CodeableConcept Container material --></material>
   <type><!-- 0..1 CodeableConcept Kind of container associated with the kind of specimen --></type>
   <cap><!-- 0..1 CodeableConcept Color of container cap --></cap>
   <description value="[string]"/><!-- 0..1 Container description -->
   <capacity><!-- 0..1 Quantity(SimpleQuantity) Container capacity --></capacity>
   <minimumVolume[x]><!-- 0..1 Quantity(SimpleQuantity)|string Minimum volume --></minimumVolume[x]>
   <additive>  <!-- 0..* Additive associated with container -->
    <additive[x]><!-- 1..1 CodeableConcept|Reference(Substance) Additive associated with container --></additive[x]>
   </additive>
   <preparation value="[string]"/><!-- 0..1 Specimen container preparation -->
  </container>
  <requirement value="[string]"/><!-- 0..1 Specimen requirements -->
  <retentionTime><!-- 0..1 Duration Specimen retention time --></retentionTime>
  <rejectionCriterion><!-- 0..* CodeableConcept Rejection criterion --></rejectionCriterion>
  <handling>  <!-- 0..* Specimen handling before testing -->
   <temperatureQualifier><!-- 0..1 CodeableConcept Temperature qualifier --></temperatureQualifier>
   <temperatureRange><!-- 0..1 Range Temperature range --></temperatureRange>
   <maxDuration><!-- 0..1 Duration Maximum preservation time --></maxDuration>
   <instruction value="[string]"/><!-- 0..1 Preservation instruction -->

  </handling>
 </specimenToLab>

 </typeTested>

</SpecimenDefinition>

JSON Template

{doco
  "resourceType" : "SpecimenDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Business identifier of a kind of specimen
  "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 }, // Container material
      "type" : { CodeableConcept }, // Kind of container associated with the kind of specimen
      "cap" : { CodeableConcept }, // Color of container cap
      "description" : "<string>", // Container description
      "capacity" : { Quantity(SimpleQuantity) }, // Container capacity
      // 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(Substance) }
      }],
      "preparation" : "<string>" // Specimen container preparation
    },
    "requirement" : "<string>", // Specimen requirements
    "retentionTime" : { Duration }, // Specimen retention time
    "rejectionCriterion" : [{ CodeableConcept }], // Rejection criterion
    "handling" : [{ // Specimen handling before testing
      "temperatureQualifier" : { CodeableConcept }, // Temperature qualifier
      "temperatureRange" : { Range }, // Temperature range
      "maxDuration" : { Duration }, // Maximum preservation time
      "instruction" : "<string>" // Preservation instruction

    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:SpecimenDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:SpecimenDefinition.identifier [ Identifier ]; # 0..1 Business identifier of a kind of specimen
  fhir:SpecimenDefinition.typeCollected [ CodeableConcept ]; # 0..1 Kind of material to collect
  fhir:

  fhir:SpecimenDefinition.patientPreparation [ CodeableConcept ], ... ; # 0..* Patient preparation for collection

  fhir:SpecimenDefinition.timeAspect [ string ]; # 0..1 Time aspect for collection
  fhir:SpecimenDefinition.collection [ CodeableConcept ], ... ; # 0..* Specimen collection procedure
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      # . One of these 2
        fhir: ]
        fhir:) ]
    ], ...;
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:

  fhir:SpecimenDefinition.typeTested [ # 0..* Specimen in container intended for testing by lab
    fhir:SpecimenDefinition.typeTested.isDerived [ boolean ]; # 0..1 Primary or secondary specimen
    fhir:SpecimenDefinition.typeTested.type [ CodeableConcept ]; # 0..1 Type of intended specimen
    fhir:SpecimenDefinition.typeTested.preference [ code ]; # 1..1 preferred | alternate
    fhir:SpecimenDefinition.typeTested.container [ # 0..1 The specimen's container
      fhir:SpecimenDefinition.typeTested.container.material [ CodeableConcept ]; # 0..1 Container material
      fhir:SpecimenDefinition.typeTested.container.type [ CodeableConcept ]; # 0..1 Kind of container associated with the kind of specimen
      fhir:SpecimenDefinition.typeTested.container.cap [ CodeableConcept ]; # 0..1 Color of container cap
      fhir:SpecimenDefinition.typeTested.container.description [ string ]; # 0..1 Container description
      fhir:SpecimenDefinition.typeTested.container.capacity [ Quantity(SimpleQuantity) ]; # 0..1 Container capacity
      # SpecimenDefinition.typeTested.container.minimumVolume[x] : 0..1 Minimum volume. One of these 2
        fhir:SpecimenDefinition.typeTested.container.minimumVolumeSimpleQuantity [ Quantity(SimpleQuantity) ]
        fhir:SpecimenDefinition.typeTested.container.minimumVolumeString [ string ]
      fhir:SpecimenDefinition.typeTested.container.additive [ # 0..* Additive associated with container
        # SpecimenDefinition.typeTested.container.additive.additive[x] : 1..1 Additive associated with container. One of these 2
          fhir:SpecimenDefinition.typeTested.container.additive.additiveCodeableConcept [ CodeableConcept ]
          fhir:SpecimenDefinition.typeTested.container.additive.additiveReference [ Reference(Substance) ]
      ], ...;
      fhir:SpecimenDefinition.typeTested.container.preparation [ string ]; # 0..1 Specimen container preparation
    ];
    fhir:SpecimenDefinition.typeTested.requirement [ string ]; # 0..1 Specimen requirements
    fhir:SpecimenDefinition.typeTested.retentionTime [ Duration ]; # 0..1 Specimen retention time
    fhir:SpecimenDefinition.typeTested.rejectionCriterion [ CodeableConcept ], ... ; # 0..* Rejection criterion
    fhir:SpecimenDefinition.typeTested.handling [ # 0..* Specimen handling before testing
      fhir:SpecimenDefinition.typeTested.handling.temperatureQualifier [ CodeableConcept ]; # 0..1 Temperature qualifier
      fhir:SpecimenDefinition.typeTested.handling.temperatureRange [ Range ]; # 0..1 Temperature range
      fhir:SpecimenDefinition.typeTested.handling.maxDuration [ Duration ]; # 0..1 Maximum preservation time
      fhir:SpecimenDefinition.typeTested.handling.instruction [ string ]; # 0..1 Preservation instruction

    ], ...;
  ], ...;
]

Changes since R3

SpecimenDefinition
SpecimenDefinition.typeTested.preference
  • Change value set from http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.0 to http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.1.0
SpecimenDefinition.typeTested.container.minimumVolume[x]
  • Add Type Quantity()
  • Remove Type Quantity()

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

Structure

lightExposure 0..1 string Light exposure
Name Flags Card. Type Description & Constraints doco
. . SpecimenDefinition TU DomainResource Kind of specimen
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..1 Identifier Business identifier of a kind of specimen
. . . typeCollected Σ 0..1 CodeableConcept Kind of material to collect
v2 Specimen Type ( Example )
. . . patientPreparation Σ 0..1 0..* string CodeableConcept Patient preparation for collection
Patient preparation prior specimen collection ( Example )
. . . timeAspect Σ 0..1 string Time aspect for collection
. . . collection Σ 0..* CodeableConcept Specimen collection procedure
Specimen collection methods ( Example )
. . . specimenToLab typeTested 0..* BackboneElement Specimen in container intended for testing by lab
. . . . isDerived 1..1 0..1 boolean Primary or secondary specimen
. . . . type 0..1 CodeableConcept Type of intended specimen
v2 Specimen Type ( Example )
. . . . preference 1..1 code preferred | alternate
SpecimenContainedPreference ( Required )
. . . . container 0..1 BackboneElement The specimen's container
. . . . . containerMaterial material 0..1 CodeableConcept Container material
Types of material for specimen containers ( Example )
. . . . . containerType type 0..1 CodeableConcept Kind of container associated with the kind of specimen
LOINC Codes for Cholesterol in Serum/Plasma Specimen Container Type ( Example )
. . . . . containerCap cap 0..1 CodeableConcept Color of container cap
ContainerCap ( Example )
. . . . . containerDescription description 0..1 string Container description
. . . . . containerCapacity capacity 0..1 SimpleQuantity Container capacity
. . . . containerMinimumVolume . minimumVolume[x] 0..1 Minimum volume
...... minimumVolumeQuantity SimpleQuantity Minimum volume
. . . . . . minimumVolumeString string
... . . containerAdditive additive 0..* BackboneElement Additive associated with container
. . . . . . additive[x] 1..1 Additive associated with container
v2 Additive/Preservative Additive ( Example )
. . . . . . . additiveCodeableConcept CodeableConcept
. . . . . . . additiveReference Reference ( Substance )
. . . . . containerPreparation preparation 0..1 string Specimen container preparation
. . . . requirement 0..1 string Specimen requirements
. . . . retentionTime 0..1 Duration Specimen retention time
. . . . rejectionCriterion 0..* CodeableConcept Rejection criterion
RejectionCriterion ( Example )
. . . . handling 0..* BackboneElement Specimen handling before testing
. . . . . conditionSet temperatureQualifier 0..1 CodeableConcept Conservation condition set Temperature qualifier
HandlingConditionSet ( Example )
. . . . . tempRange temperatureRange 0..1 Range Temperature range
. . . . . maxDuration 0..1 Duration Maximum conservation preservation time
. . . . . instruction 0..1 string Conservation Preservation instruction

doco Documentation for this format

UML Diagram ( Legend )

SpecimenDefinition ( DomainResource ) A business identifier associated with the kind of specimen identifier : Identifier [0..1] The kind of material to be collected typeCollected : CodeableConcept [0..1] « The type of the specimen to be collected. (Strength=Example) v2 Specimen Type v2.0487 ?? » Preparation of the patient for specimen collection patientPreparation : string CodeableConcept [0..1] [0..*] « Checks on the patient prior specimen collection. (Strength=Example) PreparePatient ?? » Time aspect of specimen collection (duration or offset) timeAspect : string [0..1] The action to be performed for collecting the specimen collection : CodeableConcept [0..*] « The action to collect a type of specimen. (Strength=Example) SpecimenCollection ?? » SpecimenToLab TypeTested Primary of secondary specimen isDerived : boolean [1..1] [0..1] The kind of specimen conditioned for testing expected by lab type : CodeableConcept [0..1] « The type of specimen conditioned in a container for lab testing testing. (Strength=Example) v2 Specimen Type v2.0487 ?? » The preference for this type of conditioned specimen preference : code [1..1] « Degree of preference of a type of conditioned specimen specimen. (Strength=Required) SpecimenContainedPreference ! » Requirements for delivery and special handling of this kind of conditioned specimen requirement : string [0..1] The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing retentionTime : Duration [0..1] Criterion for rejection of the specimen in its container by the laboratory rejectionCriterion : CodeableConcept [0..*] « Criterion for rejection of the specimen by laboratory. (Strength=Example) RejectionCriterion ?? » Container The type of material of the container containerMaterial material : CodeableConcept [0..1] « Types of material for specimen containers. (Strength=Example) ContainerMaterials ?? » The type of container used to contain this kind of specimen containerType type : CodeableConcept [0..1] « Type of specimen container container. (Strength=Example) LOINC Codes for Cholesterol i... SpecimenContainerType ?? » Color of container cap containerCap cap : CodeableConcept [0..1] « Color of the container cap cap. (Strength=Example) ContainerCap ?? » The textual description of the kind of container containerDescription description : string [0..1] The capacity (volume or other measure) of this kind of container containerCapacity capacity : Quantity ( SimpleQuantity ) [0..1] The minimum volume to be conditioned in the container containerMinimumVolume minimumVolume[x] : Type [0..1] « Quantity ( SimpleQuantity ) [0..1] )| string » Special processing that should be applied to the container for this kind of specimen containerPreparation : string [0..1] Requirements for delivery and special handling of this kind of conditioned specimen requirement preparation : string [0..1] The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing retentionTime : Duration [0..1] Criterion for rejection of the specimen in its container by the laboratory rejectionCriterion : CodeableConcept [0..*] « Criterion for rejection of the specimen by laboratory (Strength=Example) RejectionCriterion ?? » ContainerAdditive Additive Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA additive[x] : Type [1..1] « CodeableConcept | Reference ( Substance ); Substance added to specimen container container. (Strength=Example) v2 Additive/Preservative v2.0371 ?? » Handling Code representing It qualifies the set interval of handling instructions temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element conditionSet temperatureQualifier : CodeableConcept [0..1] « Set of handling instructions prior testing of the specimen specimen. (Strength=Example) HandlingConditionSet ?? » The temperature interval for this set of handling instructions tempRange temperatureRange : Range [0..1] The maximum time interval of conservation preservation of the specimen with these conditions maxDuration : Duration [0..1] Textual instructions regarding the light exposure of the specimen prior testing lightExposure : string [0..1] Additional textual instructions for the conservation preservation or transport of the specimen specimen. For instance, 'Protect from light exposure' instruction : string [0..1] Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA containerAdditive additive [0..*] The specimen's container container [0..1] Set of instructions for conservation/transport preservation/transport of the specimen at a defined temperature interval, prior the testing process handling [0..*] Specimen conditioned in a container as expected by the testing laboratory specimenToLab typeTested [0..*]

XML Template

<SpecimenDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business identifier of a kind of specimen --></identifier>
 <typeCollected><!-- 0..1 CodeableConcept Kind of material to collect --></typeCollected>
 <

 <patientPreparation><!-- 0..* CodeableConcept Patient preparation for collection --></patientPreparation>

 <timeAspect value="[string]"/><!-- 0..1 Time aspect for collection -->
 <</collection>
 <
  <
  <</type>
  <
  <</containerMaterial>
  <</containerType>
  <</containerCap>
  <
  <</containerCapacity>
  <</containerMinimumVolume>
  <
   <</additive[x]>
  </containerAdditive>
  <
  <
  <</retentionTime>
  <</rejectionCriterion>
  <
   <</conditionSet>
   <</tempRange>
   <</maxDuration>
   <
   <

 <collection><!-- 0..* CodeableConcept Specimen collection procedure --></collection>
 <typeTested>  <!-- 0..* Specimen in container intended for testing by lab -->
  <isDerived value="[boolean]"/><!-- 0..1 Primary or secondary specimen -->
  <type><!-- 0..1 CodeableConcept Type of intended specimen --></type>
  <preference value="[code]"/><!-- 1..1 preferred | alternate -->
  <container>  <!-- 0..1 The specimen's container -->
   <material><!-- 0..1 CodeableConcept Container material --></material>
   <type><!-- 0..1 CodeableConcept Kind of container associated with the kind of specimen --></type>
   <cap><!-- 0..1 CodeableConcept Color of container cap --></cap>
   <description value="[string]"/><!-- 0..1 Container description -->
   <capacity><!-- 0..1 Quantity(SimpleQuantity) Container capacity --></capacity>
   <minimumVolume[x]><!-- 0..1 Quantity(SimpleQuantity)|string Minimum volume --></minimumVolume[x]>
   <additive>  <!-- 0..* Additive associated with container -->
    <additive[x]><!-- 1..1 CodeableConcept|Reference(Substance) Additive associated with container --></additive[x]>
   </additive>
   <preparation value="[string]"/><!-- 0..1 Specimen container preparation -->
  </container>
  <requirement value="[string]"/><!-- 0..1 Specimen requirements -->
  <retentionTime><!-- 0..1 Duration Specimen retention time --></retentionTime>
  <rejectionCriterion><!-- 0..* CodeableConcept Rejection criterion --></rejectionCriterion>
  <handling>  <!-- 0..* Specimen handling before testing -->
   <temperatureQualifier><!-- 0..1 CodeableConcept Temperature qualifier --></temperatureQualifier>
   <temperatureRange><!-- 0..1 Range Temperature range --></temperatureRange>
   <maxDuration><!-- 0..1 Duration Maximum preservation time --></maxDuration>
   <instruction value="[string]"/><!-- 0..1 Preservation instruction -->

  </handling>
 </specimenToLab>

 </typeTested>

</SpecimenDefinition>

JSON Template

{doco
  "resourceType" : "SpecimenDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Business identifier of a kind of specimen
  "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 }, // Container material
      "type" : { CodeableConcept }, // Kind of container associated with the kind of specimen
      "cap" : { CodeableConcept }, // Color of container cap
      "description" : "<string>", // Container description
      "capacity" : { Quantity(SimpleQuantity) }, // Container capacity
      // 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(Substance) }
      }],
      "preparation" : "<string>" // Specimen container preparation
    },
    "requirement" : "<string>", // Specimen requirements
    "retentionTime" : { Duration }, // Specimen retention time
    "rejectionCriterion" : [{ CodeableConcept }], // Rejection criterion
    "handling" : [{ // Specimen handling before testing
      "temperatureQualifier" : { CodeableConcept }, // Temperature qualifier
      "temperatureRange" : { Range }, // Temperature range
      "maxDuration" : { Duration }, // Maximum preservation time
      "instruction" : "<string>" // Preservation instruction

    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:SpecimenDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:SpecimenDefinition.identifier [ Identifier ]; # 0..1 Business identifier of a kind of specimen
  fhir:SpecimenDefinition.typeCollected [ CodeableConcept ]; # 0..1 Kind of material to collect
  fhir:

  fhir:SpecimenDefinition.patientPreparation [ CodeableConcept ], ... ; # 0..* Patient preparation for collection

  fhir:SpecimenDefinition.timeAspect [ string ]; # 0..1 Time aspect for collection
  fhir:SpecimenDefinition.collection [ CodeableConcept ], ... ; # 0..* Specimen collection procedure
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      # . One of these 2
        fhir: ]
        fhir:) ]
    ], ...;
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:

  fhir:SpecimenDefinition.typeTested [ # 0..* Specimen in container intended for testing by lab
    fhir:SpecimenDefinition.typeTested.isDerived [ boolean ]; # 0..1 Primary or secondary specimen
    fhir:SpecimenDefinition.typeTested.type [ CodeableConcept ]; # 0..1 Type of intended specimen
    fhir:SpecimenDefinition.typeTested.preference [ code ]; # 1..1 preferred | alternate
    fhir:SpecimenDefinition.typeTested.container [ # 0..1 The specimen's container
      fhir:SpecimenDefinition.typeTested.container.material [ CodeableConcept ]; # 0..1 Container material
      fhir:SpecimenDefinition.typeTested.container.type [ CodeableConcept ]; # 0..1 Kind of container associated with the kind of specimen
      fhir:SpecimenDefinition.typeTested.container.cap [ CodeableConcept ]; # 0..1 Color of container cap
      fhir:SpecimenDefinition.typeTested.container.description [ string ]; # 0..1 Container description
      fhir:SpecimenDefinition.typeTested.container.capacity [ Quantity(SimpleQuantity) ]; # 0..1 Container capacity
      # SpecimenDefinition.typeTested.container.minimumVolume[x] : 0..1 Minimum volume. One of these 2
        fhir:SpecimenDefinition.typeTested.container.minimumVolumeSimpleQuantity [ Quantity(SimpleQuantity) ]
        fhir:SpecimenDefinition.typeTested.container.minimumVolumeString [ string ]
      fhir:SpecimenDefinition.typeTested.container.additive [ # 0..* Additive associated with container
        # SpecimenDefinition.typeTested.container.additive.additive[x] : 1..1 Additive associated with container. One of these 2
          fhir:SpecimenDefinition.typeTested.container.additive.additiveCodeableConcept [ CodeableConcept ]
          fhir:SpecimenDefinition.typeTested.container.additive.additiveReference [ Reference(Substance) ]
      ], ...;
      fhir:SpecimenDefinition.typeTested.container.preparation [ string ]; # 0..1 Specimen container preparation
    ];
    fhir:SpecimenDefinition.typeTested.requirement [ string ]; # 0..1 Specimen requirements
    fhir:SpecimenDefinition.typeTested.retentionTime [ Duration ]; # 0..1 Specimen retention time
    fhir:SpecimenDefinition.typeTested.rejectionCriterion [ CodeableConcept ], ... ; # 0..* Rejection criterion
    fhir:SpecimenDefinition.typeTested.handling [ # 0..* Specimen handling before testing
      fhir:SpecimenDefinition.typeTested.handling.temperatureQualifier [ CodeableConcept ]; # 0..1 Temperature qualifier
      fhir:SpecimenDefinition.typeTested.handling.temperatureRange [ Range ]; # 0..1 Temperature range
      fhir:SpecimenDefinition.typeTested.handling.maxDuration [ Duration ]; # 0..1 Maximum preservation time
      fhir:SpecimenDefinition.typeTested.handling.instruction [ string ]; # 0..1 Preservation instruction

    ], ...;
  ], ...;
]

Changes since DSTU2 Release 3

SpecimenDefinition
SpecimenDefinition.typeTested.preference
  • Change value set from http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.0 to http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.1.0
SpecimenDefinition.typeTested.container.minimumVolume[x]
  • Add Type Quantity()
  • Remove Type Quantity()

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis a

SpecimenDefinition.specimenToLab.containerType SpecimenDefinition.specimenToLab.containerAdditive.additive[x]
Path Definition Type Reference
SpecimenDefinition.typeCollected The type of the specimen to be collected. Example v2 Specimen Type v2.0487
SpecimenDefinition.patientPreparation Checks on the patient prior specimen collection. Example PreparePatient
SpecimenDefinition.collection The action to collect a type of specimen specimen. Unknown Example No details provided yet SpecimenCollection
SpecimenDefinition.specimenToLab.type SpecimenDefinition.typeTested.type The type of specimen conditioned in a container for lab testing testing. Example v2 Specimen Type v2.0487
SpecimenDefinition.specimenToLab.preference SpecimenDefinition.typeTested.preference Degree of preference of a type of conditioned specimen specimen. Required SpecimenContainedPreference
SpecimenDefinition.typeTested.container.material Types of material for specimen containers. Example ContainerMaterials
SpecimenDefinition.typeTested.container.type Type of specimen container container. Example LOINC Codes for Cholesterol in Serum/Plasma SpecimenContainerType
SpecimenDefinition.specimenToLab.containerCap SpecimenDefinition.typeTested.container.cap Color of the container cap cap. Example ContainerCap
SpecimenDefinition.typeTested.container.additive.additive[x] Substance added to specimen container container. Example v2 Additive/Preservative v2.0371
SpecimenDefinition.specimenToLab.rejectionCriterion SpecimenDefinition.typeTested.rejectionCriterion Criterion for rejection of the specimen by laboratory laboratory. Example RejectionCriterion
SpecimenDefinition.specimenToLab.handling.conditionSet SpecimenDefinition.typeTested.handling.temperatureQualifier Set of handling instructions prior testing of the specimen specimen. Example HandlingConditionSet

Search parameters for 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.specimenToLab.containerType SpecimenDefinition.typeTested.container.type
identifier token The unique identifier associated with the specimen SpecimenDefinition.identifier
type token The type of collected specimen SpecimenDefinition.typeCollected