Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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 Resource SpecimenDefinition - Content

Orders and Observations Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

A kind of specimen with associated set of requirements.

10.8.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 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 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.

10.8.3 References

This resource is referenced by ActivityDefinition, CatalogEntry, ObservationDefinition and itself.

This resource does not implement any patterns.

10.8.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition TUDomainResourceKind of specimen
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical canonical URL to reference this SpecimenDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier
... version Σ0..1stringBusiness version of the SpecimenDefinition
... derivedFromCanonical Σ0..*canonical(SpecimenDefinition)Based on FHIR definition of another SpecimenDefinition
... derivedFromUri Σ0..*uriBased on external definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf this SpecimenDefinition is not for real usage
... subject[x] Σ0..1Type of subject for specimen collection
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the SpecimenDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the SpecimenDefinition
... useContext 0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this SpecimenDefinition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this SpecimenDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen SpecimenDefinition was approved by publisher
... lastReviewDate 0..1dateThe date on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the SpecimenDefinition
... typeCollected Σ0..1CodeableConceptKind of material to collect
hl7VS-specimenType (Example)
... patientPreparation Σ0..*CodeableConceptPatient preparation for collection
Patient preparation prior specimen collection (Example)
... timeAspect Σ0..1stringTime aspect for collection
... collection Σ0..*CodeableConceptSpecimen collection procedure
Specimen collection methods (Example)
... typeTested 0..*BackboneElementSpecimen in container intended for testing by lab
.... isDerived 0..1booleanPrimary or secondary specimen
.... type 0..1CodeableConceptType of intended specimen
hl7VS-specimenType (Example)
.... preference 1..1codepreferred | alternate
SpecimenContainedPreference (Required)
.... container 0..1BackboneElementThe specimen's container
..... material 0..1CodeableConceptThe material type used for the container
Types of material for specimen containers (Example)
..... type 0..1CodeableConceptKind of container associated with the kind of specimen
SpecimenContainer (Example)
..... cap 0..1CodeableConceptColor of container cap
ContainerCap (Example)
..... description 0..1stringThe description of the kind of container
..... capacity 0..1SimpleQuantityThe capacity of this kind of container
..... minimumVolume[x] 0..1Minimum volume
...... minimumVolumeQuantitySimpleQuantity
...... minimumVolumeStringstring
..... additive 0..*BackboneElementAdditive associated with container
...... additive[x] 1..1Additive associated with container
hl7VS-additivePreservative (Example)
....... additiveCodeableConceptCodeableConcept
....... additiveReferenceReference(Substance)
..... preparation 0..1stringSpecial processing applied to the container for this specimen type
.... requirement 0..1stringRequirements for specimen delivery and special handling
.... retentionTime 0..1DurationThe usual time for retaining this kind of specimen
.... singleUse 0..1booleanSpecimen for single use only
.... rejectionCriterion 0..*CodeableConceptCriterion specified for specimen rejection
RejectionCriterion (Example)
.... handling 0..*BackboneElementSpecimen handling before testing
..... temperatureQualifier 0..1CodeableConceptQualifies the interval of temperature
HandlingConditionSet (Example)
..... temperatureRange 0..1RangeTemperature range for these handling instructions
..... maxDuration 0..1DurationMaximum preservation time
..... instruction 0..1stringPreservation instruction
.... testingDestination 0..*CodeableConceptWhere the specimen will be tested
Diagnostic Service Section Codes (Example)

doco Documentation for this format

UML Diagram (Legend)

SpecimenDefinition (DomainResource)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 Versionsurl : uri [0..1]A business identifier assigned to this SpecimenDefinitionidentifier : 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 uniqueversion : string [0..1]A short, descriptive, user-friendly title for the SpecimenDefinitiontitle : string [0..1]The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definitionderivedFromCanonical : 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 definitionderivedFromUri : 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]A code or group definition that describes the intended subject from which this kind of specimen is to be collectedsubject[x] : 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 withdrawaldate : dateTime [0..1]Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contactpublisher : Reference [0..1] « Practitioner|PractitionerRole| Organization »Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the SpecimenDefinition from the consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitionsuseContext : UsageContext [0..*]A jurisdiction in which the SpecimenDefinition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explains why this SpecimeDefinition is needed and why it has been designed as it haspurpose : 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 SpecimenDefinitioncopyright : markdown [0..1]The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the SpecimenDefinition content was or is planned to be effectiveeffectivePeriod : Period [0..1]The kind of material to be collectedtypeCollected : CodeableConcept [0..1] « null (Strength=Example)Hl7VSSpecimenType?? »Preparation of the patient for specimen collectionpatientPreparation : 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 specimencollection : CodeableConcept [0..*] « The action to collect a type of specimen. (Strength=Example)SpecimenCollection?? »TypeTestedPrimary of secondary specimenisDerived : boolean [0..1]The kind of specimen conditioned for testing expected by labtype : CodeableConcept [0..1] « null (Strength=Example)Hl7VSSpecimenType?? »The preference for this type of conditioned specimenpreference : code [1..1] « null (Strength=Required)SpecimenContainedPreference! »Requirements for delivery and special handling of this kind of conditioned specimenrequirement : 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 testingretentionTime : 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 laboratoryrejectionCriterion : CodeableConcept [0..*] « null (Strength=Example)RejectionCriterion?? »Where the specimen will be tested: e.g., lab, sector, device or any combination of thesetestingDestination : CodeableConcept [0..*] « null (Strength=Example) DiagnosticServiceSectionCodes?? »ContainerThe type of material of the containermaterial : CodeableConcept [0..1] « Types of material for specimen containers. (Strength=Example)ContainerMaterials?? »The type of container used to contain this kind of specimentype : CodeableConcept [0..1] « Type of specimen container. (Strength=Example)SpecimenContainer?? »Color of container capcap : CodeableConcept [0..1] « null (Strength=Example)ContainerCap?? »The textual description of the kind of containerdescription : string [0..1]The capacity (volume or other measure) of this kind of containercapacity : Quantity(SimpleQuantity) [0..1]The minimum volume to be conditioned in the containerminimumVolume[x] : DataType [0..1] « Quantity(SimpleQuantity)|string »Special processing that should be applied to the container for this kind of specimenpreparation : string [0..1]AdditiveSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTAadditive[x] : DataType [1..1] « CodeableConcept|Reference(Substance); null (Strength=Example) Hl7VSAdditivePreservative?? »HandlingIt qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction elementtemperatureQualifier : CodeableConcept [0..1] « null (Strength=Example)HandlingConditionSet?? »The temperature interval for this set of handling instructionstemperatureRange : Range [0..1]The maximum time interval of preservation of the specimen with these conditionsmaxDuration : Duration [0..1]Additional textual instructions for the preservation or transport of the 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, EDTAadditive[0..*]The specimen's containercontainer[0..1]Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing processhandling[0..*]Specimen conditioned in a container as expected by the testing laboratorytypeTested[0..*]

XML Template

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

Changes since R3

SpecimenDefinition
SpecimenDefinition.url
  • Added Element
SpecimenDefinition.version
  • 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.approvalDate
  • Added Element
SpecimenDefinition.lastReviewDate
  • Added Element
SpecimenDefinition.effectivePeriod
  • Added Element
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.6.0
SpecimenDefinition.typeTested.container.minimumVolume[x]
  • Add Type Quantity()
  • Remove Type Quantity()
SpecimenDefinition.typeTested.singleUse
  • Added Element
SpecimenDefinition.typeTested.testingDestination
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition TUDomainResourceKind of specimen
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical canonical URL to reference this SpecimenDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier
... version Σ0..1stringBusiness version of the SpecimenDefinition
... derivedFromCanonical Σ0..*canonical(SpecimenDefinition)Based on FHIR definition of another SpecimenDefinition
... derivedFromUri Σ0..*uriBased on external definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf this SpecimenDefinition is not for real usage
... subject[x] Σ0..1Type of subject for specimen collection
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the SpecimenDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the SpecimenDefinition
... useContext 0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this SpecimenDefinition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this SpecimenDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen SpecimenDefinition was approved by publisher
... lastReviewDate 0..1dateThe date on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the SpecimenDefinition
... typeCollected Σ0..1CodeableConceptKind of material to collect
hl7VS-specimenType (Example)
... patientPreparation Σ0..*CodeableConceptPatient preparation for collection
Patient preparation prior specimen collection (Example)
... timeAspect Σ0..1stringTime aspect for collection
... collection Σ0..*CodeableConceptSpecimen collection procedure
Specimen collection methods (Example)
... typeTested 0..*BackboneElementSpecimen in container intended for testing by lab
.... isDerived 0..1booleanPrimary or secondary specimen
.... type 0..1CodeableConceptType of intended specimen
hl7VS-specimenType (Example)
.... preference 1..1codepreferred | alternate
SpecimenContainedPreference (Required)
.... container 0..1BackboneElementThe specimen's container
..... material 0..1CodeableConceptThe material type used for the container
Types of material for specimen containers (Example)
..... type 0..1CodeableConceptKind of container associated with the kind of specimen
SpecimenContainer (Example)
..... cap 0..1CodeableConceptColor of container cap
ContainerCap (Example)
..... description 0..1stringThe description of the kind of container
..... capacity 0..1SimpleQuantityThe capacity of this kind of container
..... minimumVolume[x] 0..1Minimum volume
...... minimumVolumeQuantitySimpleQuantity
...... minimumVolumeStringstring
..... additive 0..*BackboneElementAdditive associated with container
...... additive[x] 1..1Additive associated with container
hl7VS-additivePreservative (Example)
....... additiveCodeableConceptCodeableConcept
....... additiveReferenceReference(Substance)
..... preparation 0..1stringSpecial processing applied to the container for this specimen type
.... requirement 0..1stringRequirements for specimen delivery and special handling
.... retentionTime 0..1DurationThe usual time for retaining this kind of specimen
.... singleUse 0..1booleanSpecimen for single use only
.... rejectionCriterion 0..*CodeableConceptCriterion specified for specimen rejection
RejectionCriterion (Example)
.... handling 0..*BackboneElementSpecimen handling before testing
..... temperatureQualifier 0..1CodeableConceptQualifies the interval of temperature
HandlingConditionSet (Example)
..... temperatureRange 0..1RangeTemperature range for these handling instructions
..... maxDuration 0..1DurationMaximum preservation time
..... instruction 0..1stringPreservation instruction
.... testingDestination 0..*CodeableConceptWhere the specimen will be tested
Diagnostic Service Section Codes (Example)

doco Documentation for this format

UML Diagram (Legend)

SpecimenDefinition (DomainResource)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 Versionsurl : uri [0..1]A business identifier assigned to this SpecimenDefinitionidentifier : 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 uniqueversion : string [0..1]A short, descriptive, user-friendly title for the SpecimenDefinitiontitle : string [0..1]The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definitionderivedFromCanonical : 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 definitionderivedFromUri : 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]A code or group definition that describes the intended subject from which this kind of specimen is to be collectedsubject[x] : 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 withdrawaldate : dateTime [0..1]Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contactpublisher : Reference [0..1] « Practitioner|PractitionerRole| Organization »Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the SpecimenDefinition from the consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitionsuseContext : UsageContext [0..*]A jurisdiction in which the SpecimenDefinition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explains why this SpecimeDefinition is needed and why it has been designed as it haspurpose : 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 SpecimenDefinitioncopyright : markdown [0..1]The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the SpecimenDefinition content was or is planned to be effectiveeffectivePeriod : Period [0..1]The kind of material to be collectedtypeCollected : CodeableConcept [0..1] « null (Strength=Example)Hl7VSSpecimenType?? »Preparation of the patient for specimen collectionpatientPreparation : 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 specimencollection : CodeableConcept [0..*] « The action to collect a type of specimen. (Strength=Example)SpecimenCollection?? »TypeTestedPrimary of secondary specimenisDerived : boolean [0..1]The kind of specimen conditioned for testing expected by labtype : CodeableConcept [0..1] « null (Strength=Example)Hl7VSSpecimenType?? »The preference for this type of conditioned specimenpreference : code [1..1] « null (Strength=Required)SpecimenContainedPreference! »Requirements for delivery and special handling of this kind of conditioned specimenrequirement : 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 testingretentionTime : 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 laboratoryrejectionCriterion : CodeableConcept [0..*] « null (Strength=Example)RejectionCriterion?? »Where the specimen will be tested: e.g., lab, sector, device or any combination of thesetestingDestination : CodeableConcept [0..*] « null (Strength=Example) DiagnosticServiceSectionCodes?? »ContainerThe type of material of the containermaterial : CodeableConcept [0..1] « Types of material for specimen containers. (Strength=Example)ContainerMaterials?? »The type of container used to contain this kind of specimentype : CodeableConcept [0..1] « Type of specimen container. (Strength=Example)SpecimenContainer?? »Color of container capcap : CodeableConcept [0..1] « null (Strength=Example)ContainerCap?? »The textual description of the kind of containerdescription : string [0..1]The capacity (volume or other measure) of this kind of containercapacity : Quantity(SimpleQuantity) [0..1]The minimum volume to be conditioned in the containerminimumVolume[x] : DataType [0..1] « Quantity(SimpleQuantity)|string »Special processing that should be applied to the container for this kind of specimenpreparation : string [0..1]AdditiveSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTAadditive[x] : DataType [1..1] « CodeableConcept|Reference(Substance); null (Strength=Example) Hl7VSAdditivePreservative?? »HandlingIt qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction elementtemperatureQualifier : CodeableConcept [0..1] « null (Strength=Example)HandlingConditionSet?? »The temperature interval for this set of handling instructionstemperatureRange : Range [0..1]The maximum time interval of preservation of the specimen with these conditionsmaxDuration : Duration [0..1]Additional textual instructions for the preservation or transport of the 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, EDTAadditive[0..*]The specimen's containercontainer[0..1]Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing processhandling[0..*]Specimen conditioned in a container as expected by the testing laboratorytypeTested[0..*]

XML Template

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

Changes since Release 3

SpecimenDefinition
SpecimenDefinition.url
  • Added Element
SpecimenDefinition.version
  • 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.approvalDate
  • Added Element
SpecimenDefinition.lastReviewDate
  • Added Element
SpecimenDefinition.effectivePeriod
  • Added Element
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.6.0
SpecimenDefinition.typeTested.container.minimumVolume[x]
  • Add Type Quantity()
  • Remove Type Quantity()
SpecimenDefinition.typeTested.singleUse
  • Added Element
SpecimenDefinition.typeTested.testingDestination
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

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

10.8.4.1 Terminology Bindings

PathDefinitionTypeReference
SpecimenDefinition.status RequiredPublicationStatus
SpecimenDefinition.jurisdiction ExtensibleJurisdiction ValueSet
SpecimenDefinition.typeCollected ExampleHl7VSSpecimenType
SpecimenDefinition.patientPreparation Checks on the patient prior specimen collection.ExamplePreparePatient
SpecimenDefinition.collection The action to collect a type of specimen.ExampleSpecimenCollection
SpecimenDefinition.typeTested.type ExampleHl7VSSpecimenType
SpecimenDefinition.typeTested.preference RequiredSpecimenContainedPreference
SpecimenDefinition.typeTested.container.material Types of material for specimen containers.ExampleContainerMaterials
SpecimenDefinition.typeTested.container.type Type of specimen container.ExampleSpecimenContainer
SpecimenDefinition.typeTested.container.cap ExampleContainerCap
SpecimenDefinition.typeTested.container.additive.additive[x] ExampleHl7VSAdditivePreservative
SpecimenDefinition.typeTested.rejectionCriterion ExampleRejectionCriterion
SpecimenDefinition.typeTested.handling.temperatureQualifier ExampleHandlingConditionSet
SpecimenDefinition.typeTested.testingDestination ExampleDiagnosticServiceSectionCodes

10.8.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
containertokenThe type of specimen conditioned in container expected by the labSpecimenDefinition.typeTested.container.type
experimental NtokenNot for genuine usage (true)SpecimenDefinition.experimental
identifiertokenThe unique identifier associated with the SpecimenDefinitionSpecimenDefinition.identifier
is-derived NtokenPrimary specimen (false) or derived specimen (true)SpecimenDefinition.typeTested.isDerived
status NtokenPublication status of the SpecimenDefinition: draft, active, retired, unknownSpecimenDefinition.status
title NstringHuman-friendly name of the SpecimenDefinitionSpecimenDefinition.title
typetokenThe type of collected specimenSpecimenDefinition.typeCollected
type-testedtokenThe type of specimen conditioned for testingSpecimenDefinition.typeTested.type
url NuriThe uri that identifies the specimen definitionSpecimenDefinition.url