Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). 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

10.8 8.30 Resource SpecimenDefinition - Content

Orders and Observations icon Work Group Maturity Level : 0 1   Trial Use Security Category : Anonymous Compartments : Not linked to any No defined compartments

A kind of specimen with associated set of requirements.

10.8.1 8.30.1 Scope and Usage

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.

10.8.2 8.30.2 Boundaries and Relationships

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 SubstanceDefinition resource, in order to describe the type of substance (body fluid, other material) concerned by a kind of specimen. It also references the Substance SubstanceDefinition resource to describe additives to be used in the production of specimens of some kind.
This resource is referenced by

8.30.3 References to this Resource

10.8.3 8.30.4 Resource Content

Structure

Rejection criterion Temperature qualifier
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
Interfaces Implemented: MetadataResource
. . identifier . 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 a kind 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 icon v2 Specimen Type ( 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 icon v2 Specimen Type ( Example )
. . . . preference 1..1 code preferred | alternate
SpecimenContainedPreference Binding: Specimen Contained Preference ( Required )
. . . . container 0..1 BackboneElement The specimen's container
. . . . . material 0..1 CodeableConcept Container 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
ContainerCap Binding: Container Cap ( Example )
. . . . . description 0..1 string markdown Container The description of the kind of container
. . . . . capacity 0..1 SimpleQuantity Container 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 icon v2 Additive ( Example )
. . . . . . . additiveCodeableConcept CodeableConcept
. . . . . . . additiveReference Reference ( Substance SubstanceDefinition )
. . . . . preparation 0..1 string markdown Specimen Special processing applied to the container preparation for this specimen type
. . . . requirement 0..1 string markdown Specimen requirements Requirements for specimen delivery and special handling
. . . . retentionTime 0..1 Duration Specimen retention The usual time for retaining this kind of specimen
. . . rejectionCriterion . singleUse 0..1 boolean Specimen for single use only
.... rejectionCriterion 0..* CodeableConcept Criterion specified for specimen rejection
RejectionCriterion Binding: Rejection Criterion ( Example )

. . . . handling 0..* BackboneElement Specimen handling before testing

. . . . . temperatureQualifier 0..1 CodeableConcept Qualifies the interval of temperature
HandlingConditionSet 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..1 0..* string CodeableConcept Preservation instruction Where the specimen will be tested
Binding: Diagnostic Service Section Codes ( Example )


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

SpecimenDefinition ( DomainResource ) + MetadataResource 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 url : uri [0..1] A business identifier associated with the kind of specimen assigned to this SpecimenDefinition identifier : Identifier [0..1] 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 version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the SpecimenDefinition title : string [0..1] The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition derivedFromCanonical : canonical [0..*] « SpecimenDefinition » 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 derivedFromUri : uri [0..*] The current state of theSpecimenDefinition (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » A flag to indicate that this SpecimenDefinition is not authored for genuine usage experimental : boolean [0..1] A code or group definition that describes the intended subject from which this kind of material specimen is to be collected typeCollected subject[x] : CodeableConcept DataType [0..1] « CodeableConcept | Reference ( Group ) » 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 date : dateTime [0..1] Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the SpecimenDefinition from the consumer's perspective description : markdown [0..1] The type 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 useContext : UsageContext [0..*] A jurisdiction in which the SpecimenDefinition is intended to be collected. used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explains why this SpecimeDefinition is needed and why it has been designed as it has purpose : markdown [0..1] Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date lastReviewDate : date [0..1] The period during which the SpecimenDefinition content was or is planned to be effective effectivePeriod : Period [0..1] The kind of material to be collected typeCollected : CodeableConcept [0..1] « null (Strength=Example) v2.0487 Hl7VSSpecimenType ?? » Preparation of the patient for specimen collection patientPreparation : CodeableConcept [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 ?? » TypeTested Primary of secondary specimen isDerived : boolean [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. null (Strength=Example) v2.0487 Hl7VSSpecimenType ?? » The preference for this type of conditioned specimen preference : code [1..1] « Degree of preference of a type of conditioned specimen. null (Strength=Required) SpecimenContainedPreference ! » Requirements for delivery and special handling of this kind of conditioned specimen requirement : string markdown [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] Specimen can be used by only one test or panel if the value is "true" singleUse : boolean [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. null (Strength=Example) RejectionCriterion ?? » Where the specimen will be tested: e.g., lab, sector, device or any combination of these testingDestination : CodeableConcept [0..*] « null (Strength=Example) DiagnosticServiceSectionCodes ?? » Container The type of material of the container material : CodeableConcept [0..1] « Types of material for specimen containers. (Strength=Example) ContainerMaterials ?? » The type of container used to contain this kind of specimen type : CodeableConcept [0..1] « Type of specimen container. (Strength=Example) SpecimenContainerType ?? » Color of container cap cap : CodeableConcept [0..1] « Color of the container cap. null (Strength=Example) ContainerCap ?? » The textual description of the kind of container description : string markdown [0..1] The capacity (volume or other measure) of this kind of container capacity : Quantity ( SimpleQuantity ) [0..1] The minimum volume to be conditioned in the container minimumVolume[x] : Type DataType [0..1] « Quantity ( SimpleQuantity )| string » Special processing that should be applied to the container for this kind of specimen preparation : string markdown [0..1] Additive Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA additive[x] : Type DataType [1..1] « CodeableConcept | Reference ( Substance SubstanceDefinition ); Substance added to specimen container. null (Strength=Example) v2.0371 Hl7VSAdditivePreservative ?? » Handling 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 temperatureQualifier : CodeableConcept [0..1] « Set of handling instructions prior testing of the specimen. null (Strength=Example) HandlingConditionSet ?? » The temperature interval for this set of handling instructions temperatureRange : Range [0..1] The maximum time interval of preservation of the specimen with these conditions maxDuration : Duration [0..1] Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure' instruction : string markdown [0..1] Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA additive [0..*] The specimen's container container [0..1] Set of instructions for 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 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>
 <</typeCollected>

 <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 icon --></typeCollected>

 <patientPreparation><!-- 0..* CodeableConcept Patient preparation for collection --></patientPreparation>
 <timeAspect value="[string]"/><!-- 0..1 Time aspect for collection -->
 <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>

  <type><!-- 0..1 CodeableConcept Type of intended specimen icon --></type>

  <preference value="[code]"/><!-- 1..1 preferred | alternate -->
  <container>  <!-- 0..1 The specimen's container -->
   <</material>

   <material><!-- 0..1 CodeableConcept The material type used for the container --></material>

   <type><!-- 0..1 CodeableConcept Kind of container associated with the kind of specimen --></type>
   <cap><!-- 0..1 CodeableConcept Color of container cap --></cap>
   <
   <</capacity>

   <description value="[markdown]"/><!-- 0..1 The description of the kind of container -->
   <capacity><!-- 0..1 Quantity(SimpleQuantity) The capacity of this kind of container --></capacity>

   <minimumVolume[x]><!-- 0..1 Quantity(SimpleQuantity)|string Minimum volume --></minimumVolume[x]>
   <additive>  <!-- 0..* Additive associated with container -->
    <</additive[x]>

    <additive[x]><!-- 1..1 CodeableConcept|Reference(SubstanceDefinition) Additive associated with container icon --></additive[x]>

   </additive>
   <

   <preparation value="[markdown]"/><!-- 0..1 Special processing applied to the container for this specimen type -->

  </container>
  <
  <</retentionTime>
  <</rejectionCriterion>

  <requirement value="[markdown]"/><!-- 0..1 Requirements for specimen delivery and special handling -->
  <retentionTime><!-- 0..1 Duration The usual time for retaining this kind of specimen --></retentionTime>
  <singleUse value="[boolean]"/><!-- 0..1 Specimen for single use only -->
  <rejectionCriterion><!-- 0..* CodeableConcept Criterion specified for specimen rejection --></rejectionCriterion>

  <handling>  <!-- 0..* Specimen handling before testing -->
   <</temperatureQualifier>
   <</temperatureRange>

   <temperatureQualifier><!-- 0..1 CodeableConcept Qualifies the interval of temperature --></temperatureQualifier>
   <temperatureRange><!-- 0..1 Range Temperature range for these handling instructions --></temperatureRange>

   <maxDuration><!-- 0..1 Duration Maximum preservation time --></maxDuration>
   <

   <instruction value="[markdown]"/><!-- 0..1 Preservation instruction -->

  </handling>
  <testingDestination><!-- 0..* CodeableConcept Where the specimen will be tested --></testingDestination>

 </typeTested>
</SpecimenDefinition>

JSON Template 

{doco
  "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 icon

  "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 icon

    "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/> .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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      # . One of these 2
        fhir:) ]
        fhir: ]
      fhir:
        # . One of these 2
          fhir: ]
          fhir:) ]
      ], ...;
      fhir:
    ];
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ], ...;
  ], ...;

  fhir:url [ uri ] ; # 0..1 Logical canonical URL to reference this SpecimenDefinition (globally unique)
  fhir:identifier [ Identifier ] ; # 0..1 Business identifier
  fhir:version [ string ] ; # 0..1 Business version of the SpecimenDefinition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 Name for this {{title}} (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this SpecimenDefinition (Human friendly)
  fhir:derivedFromCanonical  ( [ canonical(SpecimenDefinition) ] ... ) ; # 0..* Based on FHIR definition of another SpecimenDefinition
  fhir:derivedFromUri  ( [ uri ] ... ) ; # 0..* Based on external definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 If this SpecimenDefinition is not for real usage
  # subject[x] : 0..1 Type of subject for specimen collection. One of these 2
    fhir:subject [  a fhir:CodeableConcept ; CodeableConcept ]
    fhir:subject [  a fhir:Reference ; Reference(Group) ]
  fhir:date [ dateTime ] ; # 0..1 Date status first applied
  fhir:publisher [ string ] ; # 0..1 The name of the individual or organization that published the SpecimenDefinition
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the SpecimenDefinition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* Content intends to support these contexts
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for this SpecimenDefinition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this SpecimenDefinition is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When SpecimenDefinition was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 The date on which the asset content was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 The effective date range for the SpecimenDefinition
  fhir:typeCollected [ CodeableConcept ] ; # 0..1 Kind of material to collect
  fhir:patientPreparation  ( [ CodeableConcept ] ... ) ; # 0..* Patient preparation for collection
  fhir:timeAspect [ string ] ; # 0..1 Time aspect for collection
  fhir:collection  ( [ CodeableConcept ] ... ) ; # 0..* Specimen collection procedure
  fhir:typeTested ( [ # 0..* Specimen in container intended for testing by lab
    fhir:isDerived [ boolean ] ; # 0..1 Primary or secondary specimen
    fhir:type [ CodeableConcept ] ; # 0..1 Type of intended specimen
    fhir:preference [ code ] ; # 1..1 preferred | alternate
    fhir:container [ # 0..1 The specimen's container
      fhir:material [ CodeableConcept ] ; # 0..1 The material type used for the container
      fhir:type [ CodeableConcept ] ; # 0..1 Kind of container associated with the kind of specimen
      fhir:cap [ CodeableConcept ] ; # 0..1 Color of container cap
      fhir:description [ markdown ] ; # 0..1 The description of the kind of container
      fhir:capacity [ Quantity(SimpleQuantity) ] ; # 0..1 The capacity of this kind of container
      # minimumVolume[x] : 0..1 Minimum volume. One of these 2
        fhir:minimumVolume [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
        fhir:minimumVolume [  a fhir:string ; string ]
      fhir:additive ( [ # 0..* Additive associated with container
        # additive[x] : 1..1 Additive associated with container. One of these 2
          fhir:additive [  a fhir:CodeableConcept ; CodeableConcept ]
          fhir:additive [  a fhir:Reference ; Reference(SubstanceDefinition) ]
      ] ... ) ;
      fhir:preparation [ markdown ] ; # 0..1 Special processing applied to the container for this specimen type
    ] ;
    fhir:requirement [ markdown ] ; # 0..1 Requirements for specimen delivery and special handling
    fhir:retentionTime [ Duration ] ; # 0..1 The usual time for retaining this kind of specimen
    fhir:singleUse [ boolean ] ; # 0..1 Specimen for single use only
    fhir:rejectionCriterion  ( [ CodeableConcept ] ... ) ; # 0..* Criterion specified for specimen rejection
    fhir:handling ( [ # 0..* Specimen handling before testing
      fhir:temperatureQualifier [ CodeableConcept ] ; # 0..1 Qualifies the interval of temperature
      fhir:temperatureRange [ Range ] ; # 0..1 Temperature range for these handling instructions
      fhir:maxDuration [ Duration ] ; # 0..1 Maximum preservation time
      fhir:instruction [ markdown ] ; # 0..1 Preservation instruction
    ] ... ) ;
    fhir:testingDestination  ( [ CodeableConcept ] ... ) ; # 0..* Where the specimen will be tested
  ] ... ) ;

]

Changes since R3 from both R4 and R4B

SpecimenDefinition
SpecimenDefinition.url
  • Added Element
SpecimenDefinition.version
  • Added Element
SpecimenDefinition.versionAlgorithm[x]
  • Added Element
SpecimenDefinition.name
  • Added Element
SpecimenDefinition.title
  • Added Element
SpecimenDefinition.derivedFromCanonical
  • Added Element
SpecimenDefinition.derivedFromUri
  • Added Element
SpecimenDefinition.status
  • Added Mandatory Element
SpecimenDefinition.experimental
  • Added Element
SpecimenDefinition.subject[x]
  • Added Element
SpecimenDefinition.date
  • Added Element
SpecimenDefinition.publisher
  • Added Element
SpecimenDefinition.contact
  • Added Element
SpecimenDefinition.description
  • Added Element
SpecimenDefinition.useContext
  • Added Element
SpecimenDefinition.jurisdiction
  • Added Element
SpecimenDefinition.purpose
  • Added Element
SpecimenDefinition.copyright
  • Added Element
SpecimenDefinition.copyrightLabel
  • Added Element
SpecimenDefinition.approvalDate
  • Added Element
SpecimenDefinition.lastReviewDate
  • Added Element
SpecimenDefinition.effectivePeriod
  • Added Element
SpecimenDefinition.typeTested.container.description
  • Type changed from string to markdown
SpecimenDefinition.typeTested.container.preparation
  • Type changed from string to markdown
SpecimenDefinition.typeTested.requirement
  • Type changed from string to markdown
SpecimenDefinition.typeTested.singleUse
  • Added Element
SpecimenDefinition.typeTested.handling.instruction
  • Type changed from string to markdown
SpecimenDefinition.typeTested.testingDestination
  • Added Element

This resource did not exist in Release 2 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 R3 <--> R4 <--> R5 Conversion Maps (status = Not Mapped) See Conversions Summary .)

Structure

Rejection criterion Temperature qualifier
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
Interfaces Implemented: MetadataResource
. . identifier . 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 a kind 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 icon v2 Specimen Type ( 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 icon v2 Specimen Type ( Example )
. . . . preference 1..1 code preferred | alternate
SpecimenContainedPreference Binding: Specimen Contained Preference ( Required )
. . . . container 0..1 BackboneElement The specimen's container
. . . . . material 0..1 CodeableConcept Container 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
ContainerCap Binding: Container Cap ( Example )
. . . . . description 0..1 string markdown Container The description of the kind of container
. . . . . capacity 0..1 SimpleQuantity Container 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 icon v2 Additive ( Example )
. . . . . . . additiveCodeableConcept CodeableConcept
. . . . . . . additiveReference Reference ( Substance SubstanceDefinition )
. . . . . preparation 0..1 string markdown Specimen Special processing applied to the container preparation for this specimen type
. . . . requirement 0..1 string markdown Specimen requirements Requirements for specimen delivery and special handling
. . . . retentionTime 0..1 Duration Specimen retention The usual time for retaining this kind of specimen
. . . rejectionCriterion . singleUse 0..1 boolean Specimen for single use only
.... rejectionCriterion 0..* CodeableConcept Criterion specified for specimen rejection
RejectionCriterion Binding: Rejection Criterion ( Example )

. . . . handling 0..* BackboneElement Specimen handling before testing

. . . . . temperatureQualifier 0..1 CodeableConcept Qualifies the interval of temperature
HandlingConditionSet 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..1 0..* string CodeableConcept Preservation instruction Where the specimen will be tested
Binding: Diagnostic Service Section Codes ( Example )


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

SpecimenDefinition ( DomainResource ) + MetadataResource 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 url : uri [0..1] A business identifier associated with the kind of specimen assigned to this SpecimenDefinition identifier : Identifier [0..1] 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 version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the SpecimenDefinition title : string [0..1] The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition derivedFromCanonical : canonical [0..*] « SpecimenDefinition » 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 derivedFromUri : uri [0..*] The current state of theSpecimenDefinition (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » A flag to indicate that this SpecimenDefinition is not authored for genuine usage experimental : boolean [0..1] A code or group definition that describes the intended subject from which this kind of material specimen is to be collected typeCollected subject[x] : CodeableConcept DataType [0..1] « CodeableConcept | Reference ( Group ) » 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 date : dateTime [0..1] Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the SpecimenDefinition from the consumer's perspective description : markdown [0..1] The type 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 useContext : UsageContext [0..*] A jurisdiction in which the SpecimenDefinition is intended to be collected. used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explains why this SpecimeDefinition is needed and why it has been designed as it has purpose : markdown [0..1] Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date lastReviewDate : date [0..1] The period during which the SpecimenDefinition content was or is planned to be effective effectivePeriod : Period [0..1] The kind of material to be collected typeCollected : CodeableConcept [0..1] « null (Strength=Example) v2.0487 Hl7VSSpecimenType ?? » Preparation of the patient for specimen collection patientPreparation : CodeableConcept [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 ?? » TypeTested Primary of secondary specimen isDerived : boolean [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. null (Strength=Example) v2.0487 Hl7VSSpecimenType ?? » The preference for this type of conditioned specimen preference : code [1..1] « Degree of preference of a type of conditioned specimen. null (Strength=Required) SpecimenContainedPreference ! » Requirements for delivery and special handling of this kind of conditioned specimen requirement : string markdown [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] Specimen can be used by only one test or panel if the value is "true" singleUse : boolean [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. null (Strength=Example) RejectionCriterion ?? » Where the specimen will be tested: e.g., lab, sector, device or any combination of these testingDestination : CodeableConcept [0..*] « null (Strength=Example) DiagnosticServiceSectionCodes ?? » Container The type of material of the container material : CodeableConcept [0..1] « Types of material for specimen containers. (Strength=Example) ContainerMaterials ?? » The type of container used to contain this kind of specimen type : CodeableConcept [0..1] « Type of specimen container. (Strength=Example) SpecimenContainerType ?? » Color of container cap cap : CodeableConcept [0..1] « Color of the container cap. null (Strength=Example) ContainerCap ?? » The textual description of the kind of container description : string markdown [0..1] The capacity (volume or other measure) of this kind of container capacity : Quantity ( SimpleQuantity ) [0..1] The minimum volume to be conditioned in the container minimumVolume[x] : Type DataType [0..1] « Quantity ( SimpleQuantity )| string » Special processing that should be applied to the container for this kind of specimen preparation : string markdown [0..1] Additive Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA additive[x] : Type DataType [1..1] « CodeableConcept | Reference ( Substance SubstanceDefinition ); Substance added to specimen container. null (Strength=Example) v2.0371 Hl7VSAdditivePreservative ?? » Handling 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 temperatureQualifier : CodeableConcept [0..1] « Set of handling instructions prior testing of the specimen. null (Strength=Example) HandlingConditionSet ?? » The temperature interval for this set of handling instructions temperatureRange : Range [0..1] The maximum time interval of preservation of the specimen with these conditions maxDuration : Duration [0..1] Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure' instruction : string markdown [0..1] Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA additive [0..*] The specimen's container container [0..1] Set of instructions for 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 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>
 <</typeCollected>

 <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 icon --></typeCollected>

 <patientPreparation><!-- 0..* CodeableConcept Patient preparation for collection --></patientPreparation>
 <timeAspect value="[string]"/><!-- 0..1 Time aspect for collection -->
 <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>

  <type><!-- 0..1 CodeableConcept Type of intended specimen icon --></type>

  <preference value="[code]"/><!-- 1..1 preferred | alternate -->
  <container>  <!-- 0..1 The specimen's container -->
   <</material>

   <material><!-- 0..1 CodeableConcept The material type used for the container --></material>

   <type><!-- 0..1 CodeableConcept Kind of container associated with the kind of specimen --></type>
   <cap><!-- 0..1 CodeableConcept Color of container cap --></cap>
   <
   <</capacity>

   <description value="[markdown]"/><!-- 0..1 The description of the kind of container -->
   <capacity><!-- 0..1 Quantity(SimpleQuantity) The capacity of this kind of container --></capacity>

   <minimumVolume[x]><!-- 0..1 Quantity(SimpleQuantity)|string Minimum volume --></minimumVolume[x]>
   <additive>  <!-- 0..* Additive associated with container -->
    <</additive[x]>

    <additive[x]><!-- 1..1 CodeableConcept|Reference(SubstanceDefinition) Additive associated with container icon --></additive[x]>

   </additive>
   <

   <preparation value="[markdown]"/><!-- 0..1 Special processing applied to the container for this specimen type -->

  </container>
  <
  <</retentionTime>
  <</rejectionCriterion>

  <requirement value="[markdown]"/><!-- 0..1 Requirements for specimen delivery and special handling -->
  <retentionTime><!-- 0..1 Duration The usual time for retaining this kind of specimen --></retentionTime>
  <singleUse value="[boolean]"/><!-- 0..1 Specimen for single use only -->
  <rejectionCriterion><!-- 0..* CodeableConcept Criterion specified for specimen rejection --></rejectionCriterion>

  <handling>  <!-- 0..* Specimen handling before testing -->
   <</temperatureQualifier>
   <</temperatureRange>

   <temperatureQualifier><!-- 0..1 CodeableConcept Qualifies the interval of temperature --></temperatureQualifier>
   <temperatureRange><!-- 0..1 Range Temperature range for these handling instructions --></temperatureRange>

   <maxDuration><!-- 0..1 Duration Maximum preservation time --></maxDuration>
   <

   <instruction value="[markdown]"/><!-- 0..1 Preservation instruction -->

  </handling>
  <testingDestination><!-- 0..* CodeableConcept Where the specimen will be tested --></testingDestination>

 </typeTested>
</SpecimenDefinition>

JSON Template 

{doco
  "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 icon

  "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 icon

    "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/> .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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      # . One of these 2
        fhir:) ]
        fhir: ]
      fhir:
        # . One of these 2
          fhir: ]
          fhir:) ]
      ], ...;
      fhir:
    ];
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ], ...;
  ], ...;

  fhir:url [ uri ] ; # 0..1 Logical canonical URL to reference this SpecimenDefinition (globally unique)
  fhir:identifier [ Identifier ] ; # 0..1 Business identifier
  fhir:version [ string ] ; # 0..1 Business version of the SpecimenDefinition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 Name for this {{title}} (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this SpecimenDefinition (Human friendly)
  fhir:derivedFromCanonical  ( [ canonical(SpecimenDefinition) ] ... ) ; # 0..* Based on FHIR definition of another SpecimenDefinition
  fhir:derivedFromUri  ( [ uri ] ... ) ; # 0..* Based on external definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 If this SpecimenDefinition is not for real usage
  # subject[x] : 0..1 Type of subject for specimen collection. One of these 2
    fhir:subject [  a fhir:CodeableConcept ; CodeableConcept ]
    fhir:subject [  a fhir:Reference ; Reference(Group) ]
  fhir:date [ dateTime ] ; # 0..1 Date status first applied
  fhir:publisher [ string ] ; # 0..1 The name of the individual or organization that published the SpecimenDefinition
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the SpecimenDefinition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* Content intends to support these contexts
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for this SpecimenDefinition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this SpecimenDefinition is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When SpecimenDefinition was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 The date on which the asset content was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 The effective date range for the SpecimenDefinition
  fhir:typeCollected [ CodeableConcept ] ; # 0..1 Kind of material to collect
  fhir:patientPreparation  ( [ CodeableConcept ] ... ) ; # 0..* Patient preparation for collection
  fhir:timeAspect [ string ] ; # 0..1 Time aspect for collection
  fhir:collection  ( [ CodeableConcept ] ... ) ; # 0..* Specimen collection procedure
  fhir:typeTested ( [ # 0..* Specimen in container intended for testing by lab
    fhir:isDerived [ boolean ] ; # 0..1 Primary or secondary specimen
    fhir:type [ CodeableConcept ] ; # 0..1 Type of intended specimen
    fhir:preference [ code ] ; # 1..1 preferred | alternate
    fhir:container [ # 0..1 The specimen's container
      fhir:material [ CodeableConcept ] ; # 0..1 The material type used for the container
      fhir:type [ CodeableConcept ] ; # 0..1 Kind of container associated with the kind of specimen
      fhir:cap [ CodeableConcept ] ; # 0..1 Color of container cap
      fhir:description [ markdown ] ; # 0..1 The description of the kind of container
      fhir:capacity [ Quantity(SimpleQuantity) ] ; # 0..1 The capacity of this kind of container
      # minimumVolume[x] : 0..1 Minimum volume. One of these 2
        fhir:minimumVolume [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
        fhir:minimumVolume [  a fhir:string ; string ]
      fhir:additive ( [ # 0..* Additive associated with container
        # additive[x] : 1..1 Additive associated with container. One of these 2
          fhir:additive [  a fhir:CodeableConcept ; CodeableConcept ]
          fhir:additive [  a fhir:Reference ; Reference(SubstanceDefinition) ]
      ] ... ) ;
      fhir:preparation [ markdown ] ; # 0..1 Special processing applied to the container for this specimen type
    ] ;
    fhir:requirement [ markdown ] ; # 0..1 Requirements for specimen delivery and special handling
    fhir:retentionTime [ Duration ] ; # 0..1 The usual time for retaining this kind of specimen
    fhir:singleUse [ boolean ] ; # 0..1 Specimen for single use only
    fhir:rejectionCriterion  ( [ CodeableConcept ] ... ) ; # 0..* Criterion specified for specimen rejection
    fhir:handling ( [ # 0..* Specimen handling before testing
      fhir:temperatureQualifier [ CodeableConcept ] ; # 0..1 Qualifies the interval of temperature
      fhir:temperatureRange [ Range ] ; # 0..1 Temperature range for these handling instructions
      fhir:maxDuration [ Duration ] ; # 0..1 Maximum preservation time
      fhir:instruction [ markdown ] ; # 0..1 Preservation instruction
    ] ... ) ;
    fhir:testingDestination  ( [ CodeableConcept ] ... ) ; # 0..* Where the specimen will be tested
  ] ... ) ;

]

Changes since Release 3 from both R4 and R4B

SpecimenDefinition
SpecimenDefinition.url
  • Added Element
SpecimenDefinition.version
  • Added Element
SpecimenDefinition.versionAlgorithm[x]
  • Added Element
SpecimenDefinition.name
  • Added Element
SpecimenDefinition.title
  • Added Element
SpecimenDefinition.derivedFromCanonical
  • Added Element
SpecimenDefinition.derivedFromUri
  • Added Element
SpecimenDefinition.status
  • Added Mandatory Element
SpecimenDefinition.experimental
  • Added Element
SpecimenDefinition.subject[x]
  • Added Element
SpecimenDefinition.date
  • Added Element
SpecimenDefinition.publisher
  • Added Element
SpecimenDefinition.contact
  • Added Element
SpecimenDefinition.description
  • Added Element
SpecimenDefinition.useContext
  • Added Element
SpecimenDefinition.jurisdiction
  • Added Element
SpecimenDefinition.purpose
  • Added Element
SpecimenDefinition.copyright
  • Added Element
SpecimenDefinition.copyrightLabel
  • Added Element
SpecimenDefinition.approvalDate
  • Added Element
SpecimenDefinition.lastReviewDate
  • Added Element
SpecimenDefinition.effectivePeriod
  • Added Element
SpecimenDefinition.typeTested.container.description
  • Type changed from string to markdown
SpecimenDefinition.typeTested.container.preparation
  • Type changed from string to markdown
SpecimenDefinition.typeTested.requirement
  • Type changed from string to markdown
SpecimenDefinition.typeTested.singleUse
  • Added Element
SpecimenDefinition.typeTested.handling.instruction
  • Type changed from string to markdown
SpecimenDefinition.typeTested.testingDestination
  • Added Element

This resource did not exist in Release 2 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 R3 <--> R4 <--> R5 Conversion Maps (status = Not Mapped) See Conversions Summary .)

 

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

10.8.3.1 8.30.4.1 Terminology Bindings

SpecimenDefinition.typeCollected
Path Definition ValueSet Type Reference Documentation
SpecimenDefinition.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.

SpecimenDefinition.status PublicationStatus Required

The type lifecycle status of the specimen 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 collected. used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

SpecimenDefinition.typeCollected Hl7VSSpecimenType icon (a valid code from specimenType icon ) Example v2.0487

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 Checks on the patient prior specimen collection. PreparePatient Example PreparePatient

Checks on the patient prior specimen collection. All SNOMED CT concepts descendants of 703763000 |Precondition value (qualifier value)|

SpecimenDefinition.collection The action to collect a type of specimen. SpecimenCollection Example SpecimenCollection

Actions that can be taken for the collection of specimen from a subject.

SpecimenDefinition.typeTested.type The type of specimen conditioned in a container for lab testing. Hl7VSSpecimenType icon (a valid code from specimenType icon ) Example v2.0487

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 Degree of preference of a type of conditioned specimen. SpecimenContainedPreference Required SpecimenContainedPreference

Degree of preference of a type of conditioned specimen.

SpecimenDefinition.typeTested.container.material Types of material for specimen containers. ContainerMaterials Example ContainerMaterials

This value set includes SNOMED CT codes for materials that specimen containers are made of

SpecimenDefinition.typeTested.container.type Type of specimen container. SpecimenContainerType Example SpecimenContainerType

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 Color of the container cap. ContainerCap Example ContainerCap

Color of the container cap.

SpecimenDefinition.typeTested.container.additive.additive[x] Substance added to specimen container. Hl7VSAdditivePreservative icon (a valid code from additivePreservative icon ) Example v2.0371

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 Criterion for rejection of the specimen by laboratory. RejectionCriterion Example RejectionCriterion

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 icon ) Example HandlingConditionSet

This value set includes all the codes in HL7 V2 table 0074.

10.8.4 8.30.5 Search Parameters

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 specimen 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