Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Specimen_R4 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Specimen resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Specimen
Definition

A sample to be used for analysis.

ShortSample for analysis
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Specimen.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Specimen.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Specimen.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Specimen.extension:combined
    Slice Namecombined
    Definition

    R5: Specimen.combined (new:code)

    ShortR5: grouped | pooled (new)
    Comments

    Element Specimen.combined has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.combined has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: grouped | pooled (new)) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Specimen.extension:role
    Slice Namerole
    Definition

    R5: Specimen.role (new:CodeableConcept)

    ShortR5: The role the specimen serves (new)
    Comments

    Element Specimen.role has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.role has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: The role the specimen serves (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Specimen.extension:feature
    Slice Namefeature
    Definition

    R5: Specimen.feature (new:BackboneElement)

    ShortR5: The physical feature of a specimen (new)
    Comments

    Element Specimen.feature has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.feature has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: The physical feature of a specimen (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Specimen.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Specimen.status
    Definition

    The availability of the specimen.

    Shortavailable | unavailable | unsatisfactory | entered-in-error
    Comments

    This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Control0..1
    BindingThe codes SHALL be taken from SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/specimen-status|4.0.1)

    Codes providing the status/availability of a specimen.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. Specimen
    2. Specimen.extension
    Control0..*
    SlicingThis element introduces a set of slices on Specimen.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Specimen.extension:combined
      Slice Namecombined
      Definition

      R5: Specimen.combined (new:code)

      ShortR5: grouped | pooled (new)
      Comments

      Element Specimen.combined has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.combined has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R5: grouped | pooled (new)) (Extension Type: code)
      6. Specimen.extension:role
      Slice Namerole
      Definition

      R5: Specimen.role (new:CodeableConcept)

      ShortR5: The role the specimen serves (new)
      Comments

      Element Specimen.role has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.role has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: The role the specimen serves (new)) (Extension Type: CodeableConcept)
      8. Specimen.extension:feature
      Slice Namefeature
      Definition

      R5: Specimen.feature (new:BackboneElement)

      ShortR5: The physical feature of a specimen (new)
      Comments

      Element Specimen.feature has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.feature has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: The physical feature of a specimen (new)) (Complex Extension)
      10. Specimen.subject
      12. Specimen.subject.extension
      Control0..*
      SlicingThis element introduces a set of slices on Specimen.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 14. Specimen.subject.extension:subject
        Slice Namesubject
        Definition

        R5: Specimen.subject

        ShortR5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device
        Comments

        Element Specimen.subject is mapped to FHIR R4 element Specimen.subject as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Specimen.subject with unmapped reference targets: BiologicallyDerivedProduct.

        Control0..1
        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
        16. Specimen.collection
        18. Specimen.collection.extension
        Control0..*
        SlicingThis element introduces a set of slices on Specimen.collection.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 20. Specimen.collection.extension:device
          Slice Namedevice
          Definition

          R5: Specimen.collection.device (new:CodeableReference(Device))

          ShortR5: Device used to perform collection (new)
          Comments

          Element Specimen.collection.device has a context of Specimen.collection based on following the parent source element upwards and mapping to Specimen. Element Specimen.collection.device has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension(R5: Device used to perform collection (new)) (Complex Extension)
          22. Specimen.collection.extension:procedure
          Slice Nameprocedure
          Definition

          R5: Specimen.collection.procedure (new:Reference(Procedure))

          ShortR5: The procedure that collects the specimen (new)
          Comments

          Element Specimen.collection.procedure has a context of Specimen.collection based on following the parent source element upwards and mapping to Specimen. Element Specimen.collection.procedure has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension(R5: The procedure that collects the specimen (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure))
          24. Specimen.collection.collector
          26. Specimen.collection.collector.extension
          Control0..*
          SlicingThis element introduces a set of slices on Specimen.collection.collector.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 28. Specimen.collection.collector.extension:collector
            Slice Namecollector
            Definition

            R5: Specimen.collection.collector

            ShortR5: collector
            Comments

            Element Specimen.collection.collector is mapped to FHIR R4 element Specimen.collection.collector as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Specimen.collection.collector with unmapped reference targets: Patient, RelatedPerson.

            Control0..1
            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
            30. Specimen.collection.bodySite
            32. Specimen.collection.bodySite.extension
            Control0..*
            SlicingThis element introduces a set of slices on Specimen.collection.bodySite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 34. Specimen.collection.bodySite.extension:bodySite
              Slice NamebodySite
              Definition

              R5: Specimen.collection.bodySite additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/BodyStructure)) additional types from child elements (reference)

              ShortR5: bodySite additional types
              Comments

              Element Specimen.collection.bodySite is mapped to FHIR R4 element Specimen.collection.bodySite as SourceIsBroaderThanTarget. The mappings for Specimen.collection.bodySite do not cover the following types: CodeableReference. The mappings for Specimen.collection.bodySite do not cover the following types based on type expansion: reference. Reasons for using BodyStructure reference include: 1.) Need to identify a specific site instance (e.g. a specific mole), 2.) a single pre-coordinated coded concept for the body site does not exist, 3.) a desire to represent bodySite using multiple attributes (e.g. modifiers).

              Control0..1
              TypeExtension(R5: bodySite additional types) (Extension Type: Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4, BodyStructure))
              36. Specimen.container
              38. Specimen.container.extension
              Control1..*
              SlicingThis element introduces a set of slices on Specimen.container.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 40. Specimen.container.extension:device
                Slice Namedevice
                Definition

                R5: Specimen.container.device (new:Reference(Device))

                ShortR5: Device resource for the container (new)
                Comments

                Element Specimen.container.device has a context of Specimen.container based on following the parent source element upwards and mapping to Specimen. Element Specimen.container.device has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                Control1..1
                TypeExtension(R5: Device resource for the container (new)) (Extension Type: Reference(Cross-version Profile for R5.Device for use in FHIR R4, Device))
                42. Specimen.container.extension:location
                Slice Namelocation
                Definition

                R5: Specimen.container.location (new:Reference(Location))

                ShortR5: Where the container is (new)
                Comments

                Element Specimen.container.location has a context of Specimen.container based on following the parent source element upwards and mapping to Specimen. Element Specimen.container.location has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                Control0..1
                TypeExtension(R5: Where the container is (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4, Location))

                Guidance on how to interpret the contents of this table can be foundhere

                0. Specimen
                Definition

                A sample to be used for analysis.

                ShortSample for analysis
                Control0..*
                Is Modifierfalse
                Summaryfalse
                Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                dom-6: A resource should have narrative for robust management (text.`div`.exists())
                2. Specimen.id
                Definition

                The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                ShortLogical id of this artifact
                Comments

                The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                Control0..1
                Typeid
                Is Modifierfalse
                Summarytrue
                4. Specimen.meta
                Definition

                The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                ShortMetadata about the resource
                Control0..1
                TypeMeta
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                6. Specimen.implicitRules
                Definition

                A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                ShortA set of rules under which this content was created
                Comments

                Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                Control0..1
                Typeuri
                Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                8. Specimen.language
                Definition

                The base language in which the resource is written.

                ShortLanguage of the resource content
                Comments

                Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                Control0..1
                BindingThe codes SHOULD be taken from CommonLanguages .
                (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                A human language.

                Additional BindingsPurpose
                AllLanguagesMax Binding
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                10. Specimen.text
                Definition

                A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                ShortText summary of the resource, for human interpretation
                Comments

                Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                Control0..1
                TypeNarrative
                Is Modifierfalse
                Summaryfalse
                Alternate Namesnarrative, html, xhtml, display
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                12. Specimen.contained
                Definition

                These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                ShortContained, inline Resources
                Comments

                This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                Control0..*
                TypeResource
                Is Modifierfalse
                Summaryfalse
                Alternate Namesinline resources, anonymous resources, contained resources
                14. Specimen.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Specimen.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 16. Specimen.extension:combined
                  Slice Namecombined
                  Definition

                  R5: Specimen.combined (new:code)

                  ShortR5: grouped | pooled (new)
                  Comments

                  Element Specimen.combined has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.combined has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: grouped | pooled (new)) (Extension Type: code)
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  18. Specimen.extension:role
                  Slice Namerole
                  Definition

                  R5: Specimen.role (new:CodeableConcept)

                  ShortR5: The role the specimen serves (new)
                  Comments

                  Element Specimen.role has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.role has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: The role the specimen serves (new)) (Extension Type: CodeableConcept)
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  20. Specimen.extension:feature
                  Slice Namefeature
                  Definition

                  R5: Specimen.feature (new:BackboneElement)

                  ShortR5: The physical feature of a specimen (new)
                  Comments

                  Element Specimen.feature has a context of Specimen based on following the parent source element upwards and mapping to Specimen. Element Specimen.feature has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: The physical feature of a specimen (new)) (Complex Extension)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  22. Specimen.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                  Summaryfalse
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  24. Specimen.identifier
                  Definition

                  Id for specimen.

                  ShortExternal Identifier
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  26. Specimen.accessionIdentifier
                  Definition

                  The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.

                  ShortIdentifier assigned by the lab
                  Control0..1
                  TypeIdentifier
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  28. Specimen.status
                  Definition

                  The availability of the specimen.

                  Shortavailable | unavailable | unsatisfactory | entered-in-error
                  Comments

                  This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                  Control0..1
                  BindingThe codes SHALL be taken from SpecimenStatus
                  (required to http://hl7.org/fhir/ValueSet/specimen-status|4.0.1)

                  Codes providing the status/availability of a specimen.

                  Typecode
                  Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  30. Specimen.type
                  Definition

                  The kind of material that forms the specimen.

                  ShortKind of material that forms the specimen
                  Comments

                  The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.

                  Control0..1
                  BindingFor example codes, see Hl7VSSpecimenType (3.0.0)
                  (example to http://terminology.hl7.org/ValueSet/v2-0487|3.0.0)

                  The type of the specimen.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  32. Specimen.subject
                  Definition

                  Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.

                  ShortWhere the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
                  Control0..1
                  TypeReference(Patient, Group, Device, Substance, Location)
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Must know the subject context.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  34. Specimen.subject.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  36. Specimen.subject.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Specimen.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 38. Specimen.subject.extension:subject
                    Slice Namesubject
                    Definition

                    R5: Specimen.subject

                    ShortR5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device
                    Comments

                    Element Specimen.subject is mapped to FHIR R4 element Specimen.subject as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Specimen.subject with unmapped reference targets: BiologicallyDerivedProduct.

                    Control0..1
                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    40. Specimen.subject.reference
                    Definition

                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                    ShortLiteral reference, Relative, internal or absolute URL
                    Comments

                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                    Control0..1
                    This element is affected by the following invariants: ref-1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    42. Specimen.subject.type
                    Definition

                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                    ShortType the reference refers to (e.g. "Patient")
                    Comments

                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                    Aa resource (or, for logical models, the URI of the logical model).

                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    44. Specimen.subject.identifier
                    Definition

                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                    ShortLogical reference, when literal reference is not known
                    Comments

                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    TypeIdentifier
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    46. Specimen.subject.display
                    Definition

                    Plain text narrative that identifies the resource in addition to the resource reference.

                    ShortText alternative for the resource
                    Comments

                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    48. Specimen.receivedTime
                    Definition

                    Time when specimen was received for processing or testing.

                    ShortThe time when specimen was received for processing
                    Control0..1
                    TypedateTime
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    50. Specimen.parent
                    Definition

                    Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

                    ShortSpecimen from which this specimen originated
                    Comments

                    The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.

                    Control0..*
                    TypeReference(Specimen)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    52. Specimen.request
                    Definition

                    Details concerning a service request that required a specimen to be collected.

                    ShortWhy the specimen was collected
                    Comments

                    The request may be explicit or implied such with a ServiceRequest that requires a blood draw.

                    Control0..*
                    TypeReference(ServiceRequest)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    54. Specimen.collection
                    Definition

                    Details concerning the specimen collection.

                    ShortCollection details
                    Control0..1
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    56. Specimen.collection.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    58. Specimen.collection.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Specimen.collection.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 60. Specimen.collection.extension:device
                      Slice Namedevice
                      Definition

                      R5: Specimen.collection.device (new:CodeableReference(Device))

                      ShortR5: Device used to perform collection (new)
                      Comments

                      Element Specimen.collection.device has a context of Specimen.collection based on following the parent source element upwards and mapping to Specimen. Element Specimen.collection.device has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(R5: Device used to perform collection (new)) (Complex Extension)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      62. Specimen.collection.extension:procedure
                      Slice Nameprocedure
                      Definition

                      R5: Specimen.collection.procedure (new:Reference(Procedure))

                      ShortR5: The procedure that collects the specimen (new)
                      Comments

                      Element Specimen.collection.procedure has a context of Specimen.collection based on following the parent source element upwards and mapping to Specimen. Element Specimen.collection.procedure has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(R5: The procedure that collects the specimen (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure))
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      64. Specimen.collection.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      66. Specimen.collection.collector
                      Definition

                      Person who collected the specimen.

                      ShortWho collected the specimen
                      Control0..1
                      TypeReference(Practitioner, PractitionerRole)
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      68. Specimen.collection.collector.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      70. Specimen.collection.collector.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on Specimen.collection.collector.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 72. Specimen.collection.collector.extension:collector
                        Slice Namecollector
                        Definition

                        R5: Specimen.collection.collector

                        ShortR5: collector
                        Comments

                        Element Specimen.collection.collector is mapped to FHIR R4 element Specimen.collection.collector as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Specimen.collection.collector with unmapped reference targets: Patient, RelatedPerson.

                        Control0..1
                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        74. Specimen.collection.collector.reference
                        Definition

                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                        ShortLiteral reference, Relative, internal or absolute URL
                        Comments

                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                        Control0..1
                        This element is affected by the following invariants: ref-1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        76. Specimen.collection.collector.type
                        Definition

                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                        ShortType the reference refers to (e.g. "Patient")
                        Comments

                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                        Control0..1
                        BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                        Aa resource (or, for logical models, the URI of the logical model).

                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        78. Specimen.collection.collector.identifier
                        Definition

                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                        ShortLogical reference, when literal reference is not known
                        Comments

                        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        TypeIdentifier
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        80. Specimen.collection.collector.display
                        Definition

                        Plain text narrative that identifies the resource in addition to the resource reference.

                        ShortText alternative for the resource
                        Comments

                        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        82. Specimen.collection.collected[x]
                        Definition

                        Time when specimen was collected from subject - the physiologically relevant time.

                        ShortCollection time
                        Control0..1
                        TypeChoice of: dateTime, Period
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        84. Specimen.collection.duration
                        Definition

                        The span of time over which the collection of a specimen occurred.

                        ShortHow long it took to collect specimen
                        Control0..1
                        TypeDuration
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        86. Specimen.collection.quantity
                        Definition

                        The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

                        ShortThe quantity of specimen collected
                        Control0..1
                        TypeQuantity(SimpleQuantity)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        88. Specimen.collection.method
                        Definition

                        A coded value specifying the technique that is used to perform the procedure.

                        ShortTechnique used to perform collection
                        Control0..1
                        BindingFor example codes, see FHIRSpecimenCollectionMethod
                        (example to http://hl7.org/fhir/ValueSet/specimen-collection-method|4.0.1)

                        The technique that is used to perform the procedure.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        90. Specimen.collection.bodySite
                        Definition

                        Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

                        ShortAnatomical collection site
                        Comments

                        If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension bodySite.

                        Control0..1
                        BindingFor example codes, see SNOMEDCTBodyStructures
                        (example to http://hl7.org/fhir/ValueSet/body-site|4.0.1)

                        Codes describing anatomical locations. May include laterality.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        92. Specimen.collection.bodySite.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        94. Specimen.collection.bodySite.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Specimen.collection.bodySite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 96. Specimen.collection.bodySite.extension:bodySite
                          Slice NamebodySite
                          Definition

                          R5: Specimen.collection.bodySite additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/BodyStructure)) additional types from child elements (reference)

                          ShortR5: bodySite additional types
                          Comments

                          Element Specimen.collection.bodySite is mapped to FHIR R4 element Specimen.collection.bodySite as SourceIsBroaderThanTarget. The mappings for Specimen.collection.bodySite do not cover the following types: CodeableReference. The mappings for Specimen.collection.bodySite do not cover the following types based on type expansion: reference. Reasons for using BodyStructure reference include: 1.) Need to identify a specific site instance (e.g. a specific mole), 2.) a single pre-coordinated coded concept for the body site does not exist, 3.) a desire to represent bodySite using multiple attributes (e.g. modifiers).

                          Control0..1
                          TypeExtension(R5: bodySite additional types) (Extension Type: Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4, BodyStructure))
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          98. Specimen.collection.bodySite.coding
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                          Control0..*
                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Allows for alternative encodings within a code system, and translations to other code systems.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          100. Specimen.collection.bodySite.text
                          Definition

                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                          ShortPlain text representation of the concept
                          Comments

                          Very often the text is the same as a displayName of one of the codings.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          102. Specimen.collection.fastingStatus[x]
                          Definition

                          Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

                          ShortWhether or how long patient abstained from food and/or drink
                          Comments

                          Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/​time] in 2 hour Urine --12 hours fasting), or using a component observation such asObservation.component code` = LOINC 49541-6 (Fasting status - Reported).

                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from Hl7VSRelevantClincialInformation (3.0.0)
                          (extensible to http://terminology.hl7.org/ValueSet/v2-0916|3.0.0)

                          Codes describing the fasting status of the patient.

                          TypeChoice of: CodeableConcept, Duration
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Many diagnostic tests require fasting to facilitate accurate interpretation.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          104. Specimen.processing
                          Definition

                          Details concerning processing and processing steps for the specimen.

                          ShortProcessing and processing step details
                          Control0..*
                          TypeBackboneElement
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          106. Specimen.processing.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          108. Specimen.processing.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          110. Specimen.processing.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          Requirements

                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          112. Specimen.processing.description
                          Definition

                          Textual description of procedure.

                          ShortTextual description of procedure
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          114. Specimen.processing.procedure
                          Definition

                          A coded value specifying the procedure used to process the specimen.

                          ShortIndicates the treatment step applied to the specimen
                          Control0..1
                          BindingFor example codes, see SpecimenProcessingProcedure
                          (example to http://hl7.org/fhir/ValueSet/specimen-processing-procedure|4.0.1)

                          Type indicating the technique used to process the specimen.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          116. Specimen.processing.additive
                          Definition

                          Material used in the processing step.

                          ShortMaterial used in the processing step
                          Control0..*
                          TypeReference(Substance)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          118. Specimen.processing.time[x]
                          Definition

                          A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.

                          ShortDate and time of specimen processing
                          Control0..1
                          TypeChoice of: dateTime, Period
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          120. Specimen.container
                          Definition

                          The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

                          ShortDirect container of specimen (tube/slide, etc.)
                          Control0..*
                          TypeBackboneElement
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          122. Specimen.container.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          124. Specimen.container.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control1..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Specimen.container.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 126. Specimen.container.extension:device
                            Slice Namedevice
                            Definition

                            R5: Specimen.container.device (new:Reference(Device))

                            ShortR5: Device resource for the container (new)
                            Comments

                            Element Specimen.container.device has a context of Specimen.container based on following the parent source element upwards and mapping to Specimen. Element Specimen.container.device has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                            Control1..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(R5: Device resource for the container (new)) (Extension Type: Reference(Cross-version Profile for R5.Device for use in FHIR R4, Device))
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            128. Specimen.container.extension:location
                            Slice Namelocation
                            Definition

                            R5: Specimen.container.location (new:Reference(Location))

                            ShortR5: Where the container is (new)
                            Comments

                            Element Specimen.container.location has a context of Specimen.container based on following the parent source element upwards and mapping to Specimen. Element Specimen.container.location has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(R5: Where the container is (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4, Location))
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            130. Specimen.container.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            132. Specimen.container.identifier
                            Definition

                            Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.

                            ShortId for the container
                            NoteThis is a business identifier, not a resource identifier (see discussion)
                            Control0..*
                            TypeIdentifier
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            134. Specimen.container.description
                            Definition

                            Textual description of the container.

                            ShortTextual description of the container
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            136. Specimen.container.type
                            Definition

                            The type of container associated with the specimen (e.g. slide, aliquot, etc.).

                            ShortKind of container directly associated with specimen
                            Control0..1
                            BindingFor example codes, see SpecimenContainerType
                            (example to http://hl7.org/fhir/ValueSet/specimen-container-type|4.0.1)

                            Type of specimen container.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            138. Specimen.container.capacity
                            Definition

                            The capacity (volume or other measure) the container may contain.

                            ShortContainer volume or size
                            Control0..1
                            TypeQuantity(SimpleQuantity)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            140. Specimen.container.specimenQuantity
                            Definition

                            The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.

                            ShortQuantity of specimen within container
                            Control0..1
                            TypeQuantity(SimpleQuantity)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            142. Specimen.container.additive[x]
                            Definition

                            Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

                            ShortAdditive associated with container
                            Control0..1
                            BindingFor example codes, see Hl7VSAdditivePreservative (3.0.0)
                            (example to http://terminology.hl7.org/ValueSet/v2-0371|3.0.0)

                            Substance added to specimen container.

                            TypeChoice of: CodeableConcept, Reference(Substance)
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            144. Specimen.condition
                            Definition

                            A mode or state of being that describes the nature of the specimen.

                            ShortState of the specimen
                            Comments

                            Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.

                            Control0..*
                            BindingUnless not suitable, these codes SHALL be taken from Hl7VSSpecimenCondition (3.0.0)
                            (extensible to http://terminology.hl7.org/ValueSet/v2-0493|3.0.0)

                            Codes describing the state of the specimen.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            The specimen condition can be used to assess its quality or appropriateness for a specific test.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            146. Specimen.note
                            Definition

                            To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

                            ShortComments
                            Control0..*
                            TypeAnnotation
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))