Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

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

Resource Profile: Profile_R3_Specimen_R4B - 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
Must Supportfalse
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.exists() and ('#'+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(uri) = '#').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.exists() and ('#'+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(uri) = '#').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
Must Supportfalse
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.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
Must Supportfalse
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())
6. 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.3.0
(required to http://hl7.org/fhir/ValueSet/specimen-status|4.3.0)

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
Must Supportfalse
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.meta
4. Specimen.meta.extension
Control0..*
SlicingThis element introduces a set of slices on Specimen.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Specimen.meta.extension:meta
    Slice Namemeta
    Definition

    STU3: Specimen.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

    ShortSTU3: meta additional types
    Comments

    Element Specimen.meta is mapped to FHIR R4B element Specimen.meta as SourceIsBroaderThanTarget. The mappings for Specimen.meta do not cover the following types: Meta. The mappings for Specimen.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

    Control0..1
    TypeExtension(STU3: meta additional types) (Complex Extension)
    8. Specimen.text
    10. Specimen.text.extension
    Control0..*
    SlicingThis element introduces a set of slices on Specimen.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. Specimen.text.extension:text
      Slice Nametext
      Definition

      STU3: Specimen.text additional types (Narrative) additional types from child elements (div, status)

      ShortSTU3: text additional types
      Comments

      Element Specimen.text is mapped to FHIR R4B element Specimen.text as SourceIsBroaderThanTarget. The mappings for Specimen.text do not cover the following types: Narrative. The mappings for Specimen.text do not cover the following types based on type expansion: div, status. 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 in formation is added later.

      Control0..1
      TypeExtension(STU3: text additional types) (Complex Extension)
      14. Specimen.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      16. Specimen.identifier.extension
      Control0..*
      SlicingThis element introduces a set of slices on Specimen.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 18. Specimen.identifier.extension:identifier
        Slice Nameidentifier
        Definition

        STU3: Specimen.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

        ShortSTU3: identifier additional types
        Comments

        Element Specimen.identifier is mapped to FHIR R4B element Specimen.identifier as SourceIsBroaderThanTarget. The mappings for Specimen.identifier do not cover the following types: Identifier. The mappings for Specimen.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

        Control0..*
        TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
        20. Specimen.accessionIdentifier
        22. Specimen.accessionIdentifier.extension
        Control0..*
        SlicingThis element introduces a set of slices on Specimen.accessionIdentifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 24. Specimen.accessionIdentifier.extension:accessionIdentifier
          Slice NameaccessionIdentifier
          Definition

          STU3: Specimen.accessionIdentifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

          ShortSTU3: accessionIdentifier additional types
          Comments

          Element Specimen.accessionIdentifier is mapped to FHIR R4B element Specimen.accessionIdentifier as SourceIsBroaderThanTarget. The mappings for Specimen.accessionIdentifier do not cover the following types: Identifier. The mappings for Specimen.accessionIdentifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

          Control0..1
          TypeExtension(STU3: accessionIdentifier additional types) (Extension Type: Identifier)
          26. Specimen.subject
          28. Specimen.subject.extension
          Control1..*
          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
          • 30. Specimen.subject.extension:subject
            Slice Namesubject
            Definition

            STU3: Specimen.subject

            ShortSTU3: Where the specimen came from. This may be from the patient(s) or from the environment or a device
            Comments

            Element Specimen.subject is mapped to FHIR R4B element Specimen.subject as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.subject with unmapped reference targets: Device, Group, Patient, Substance.

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

              STU3: Specimen.parent additional types from child elements (display, identifier, reference)

              ShortSTU3: parent additional types
              Comments

              Element Specimen.parent is mapped to FHIR R4B element Specimen.parent as SourceIsBroaderThanTarget. The mappings for Specimen.parent do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.parent with unmapped reference targets: Specimen. 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..*
              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
              38. Specimen.request
              40. Specimen.request.extension
              Control0..*
              SlicingThis element introduces a set of slices on Specimen.request.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 42. Specimen.request.extension:request
                Slice Namerequest
                Definition

                STU3: Specimen.request additional types from child elements (display, identifier, reference)

                ShortSTU3: request additional types
                Comments

                Element Specimen.request is mapped to FHIR R4B element Specimen.request as RelatedTo. The mappings for Specimen.request do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.request with unmapped reference targets: ProcedureRequest. The request may be explicit or implied such with a ProcedureRequest that requires a blood draw.

                Control0..*
                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                44. Specimen.collection
                46. Specimen.collection.collector
                48. 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
                • 50. Specimen.collection.collector.extension:collector
                  Slice Namecollector
                  Definition

                  STU3: Specimen.collection.collector additional types from child elements (display, identifier, reference)

                  ShortSTU3: collector additional types
                  Comments

                  Element Specimen.collection.collector is mapped to FHIR R4B element Specimen.collection.collector as SourceIsBroaderThanTarget. The mappings for Specimen.collection.collector do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.collection.collector with unmapped reference targets: Practitioner.

                  Control0..1
                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                  52. Specimen.processing
                  54. Specimen.processing.additive
                  56. Specimen.processing.additive.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on Specimen.processing.additive.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 58. Specimen.processing.additive.extension:additive
                    Slice Nameadditive
                    Definition

                    STU3: Specimen.processing.additive additional types from child elements (display, identifier, reference)

                    ShortSTU3: additive additional types
                    Comments

                    Element Specimen.processing.additive is mapped to FHIR R4B element Specimen.processing.additive as SourceIsBroaderThanTarget. The mappings for Specimen.processing.additive do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.processing.additive with unmapped reference targets: Substance.

                    Control0..*
                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                    60. Specimen.container
                    62. Specimen.container.identifier
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    64. Specimen.container.identifier.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on Specimen.container.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 66. Specimen.container.identifier.extension:identifier
                      Slice Nameidentifier
                      Definition

                      STU3: Specimen.container.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                      ShortSTU3: identifier additional types
                      Comments

                      Element Specimen.container.identifier is mapped to FHIR R4B element Specimen.container.identifier as SourceIsBroaderThanTarget. The mappings for Specimen.container.identifier do not cover the following types: Identifier. The mappings for Specimen.container.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                      Control0..*
                      TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
                      68. Specimen.container.additiveReference
                      70. Specimen.container.additiveReference.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on Specimen.container.additiveReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 72. Specimen.container.additiveReference.extension:alternateReference
                        Slice NamealternateReference
                        Definition

                        STU3: Specimen.container.additive[x] additional types from child elements (display, identifier, reference)

                        ShortSTU3: additive additional types
                        Comments

                        Element Specimen.container.additive[x] is mapped to FHIR R4B element Specimen.container.additive[x] as SourceIsBroaderThanTarget. The mappings for Specimen.container.additive[x] do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.container.additive[x] with unmapped reference targets: Substance. Source element Specimen.container.additive[x] has unmapped reference types. While the target element Specimen.container.additive[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                        74. Specimen.note
                        76. Specimen.note.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on Specimen.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 78. Specimen.note.extension:note
                          Slice Namenote
                          Definition

                          STU3: Specimen.note additional types (Annotation) additional types from child elements (author[x], text, time)

                          ShortSTU3: note additional types
                          Comments

                          Element Specimen.note is mapped to FHIR R4B element Specimen.note as SourceIsBroaderThanTarget. The mappings for Specimen.note do not cover the following types: Annotation. The mappings for Specimen.note do not cover the following types based on type expansion: author[x], text, time.

                          Control0..*
                          TypeExtension(STU3: note additional types) (Extension Type: Annotation)

                          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
                          Must Supportfalse
                          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.exists() and ('#'+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(uri) = '#').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
                          Must Supportfalse
                          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
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          6. Specimen.meta.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
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          8. Specimen.meta.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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 10. Specimen.meta.extension:meta
                            Slice Namemeta
                            Definition

                            STU3: Specimen.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                            ShortSTU3: meta additional types
                            Comments

                            Element Specimen.meta is mapped to FHIR R4B element Specimen.meta as SourceIsBroaderThanTarget. The mappings for Specimen.meta do not cover the following types: Meta. The mappings for Specimen.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

                            Control0..1
                            TypeExtension(STU3: meta additional types) (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.meta.versionId
                            Definition

                            The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                            ShortVersion specific identifier
                            Comments

                            The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                            Control0..1
                            Typeid
                            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()))
                            14. Specimen.meta.lastUpdated
                            Definition

                            When the resource last changed - e.g. when the version changed.

                            ShortWhen the resource version last changed
                            Comments

                            This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                            Control0..1
                            Typeinstant
                            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()))
                            16. Specimen.meta.source
                            Definition

                            A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                            ShortIdentifies where the resource comes from
                            Comments

                            In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                            This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                            Control0..1
                            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()))
                            18. Specimen.meta.profile
                            Definition

                            A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                            ShortProfiles this resource claims to conform to
                            Comments

                            It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                            Control0..*
                            Typecanonical(StructureDefinition)
                            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()))
                            20. Specimen.meta.security
                            Definition

                            Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                            ShortSecurity Labels applied to this resource
                            Comments

                            The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                            Control0..*
                            BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                            (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.3.0)
                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            22. Specimen.meta.tag
                            Definition

                            Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                            ShortTags applied to this resource
                            Comments

                            The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                            Control0..*
                            BindingFor example codes, see CommonTags
                            (example to http://hl7.org/fhir/ValueSet/common-tags|4.3.0)
                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            24. 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
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            26. 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.3.0)

                            IETF language tag

                            Additional BindingsPurpose
                            AllLanguagesMax Binding
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            28. 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
                            Must Supportfalse
                            Summaryfalse
                            Alternate Namesnarrative, html, xhtml, display
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            30. Specimen.text.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
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            32. Specimen.text.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.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 34. Specimen.text.extension:text
                              Slice Nametext
                              Definition

                              STU3: Specimen.text additional types (Narrative) additional types from child elements (div, status)

                              ShortSTU3: text additional types
                              Comments

                              Element Specimen.text is mapped to FHIR R4B element Specimen.text as SourceIsBroaderThanTarget. The mappings for Specimen.text do not cover the following types: Narrative. The mappings for Specimen.text do not cover the following types based on type expansion: div, status. 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 in formation is added later.

                              Control0..1
                              TypeExtension(STU3: text additional types) (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())
                              36. Specimen.text.status
                              Definition

                              The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                              Shortgenerated | extensions | additional | empty
                              Control1..1
                              BindingThe codes SHALL be taken from NarrativeStatus
                              (required to http://hl7.org/fhir/ValueSet/narrative-status|4.3.0)
                              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()))
                              38. Specimen.text.div
                              Definition

                              The actual narrative content, a stripped down version of XHTML.

                              ShortLimited xhtml content
                              Comments

                              The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                              Control1..1
                              Typexhtml
                              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()))
                              txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks())
                              txt-2: The narrative SHALL have some non-whitespace content (htmlChecks())
                              40. 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
                              Must Supportfalse
                              Summaryfalse
                              Alternate Namesinline resources, anonymous resources, contained resources
                              Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                              42. Specimen.extension
                              Definition

                              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.

                              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
                              Must Supportfalse
                              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())
                              44. 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
                              Must Supportfalse
                              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())
                              46. Specimen.identifier
                              Definition

                              Id for specimen.

                              ShortExternal Identifier
                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control0..*
                              TypeIdentifier
                              Is Modifierfalse
                              Must Supportfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              48. Specimen.identifier.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
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              50. Specimen.identifier.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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 52. Specimen.identifier.extension:identifier
                                Slice Nameidentifier
                                Definition

                                STU3: Specimen.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                ShortSTU3: identifier additional types
                                Comments

                                Element Specimen.identifier is mapped to FHIR R4B element Specimen.identifier as SourceIsBroaderThanTarget. The mappings for Specimen.identifier do not cover the following types: Identifier. The mappings for Specimen.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                Control0..*
                                TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
                                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())
                                54. Specimen.identifier.use
                                Definition

                                The purpose of this identifier.

                                Shortusual | official | temp | secondary | old (If known)
                                Comments

                                Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                Control0..1
                                BindingThe codes SHALL be taken from IdentifierUse
                                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
                                Typecode
                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

                                A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                ShortDescription of identifier
                                Comments

                                This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                Control0..1
                                BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.3.0)
                                TypeCodeableConcept
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Allows users to make use of identifiers when the identifier system is not known.

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

                                Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                ShortThe namespace for the identifier value
                                Comments

                                Identifier.system is always case sensitive.

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

                                There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                ExampleGeneral: http://www.acme.com/identifiers/patient
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                60. Specimen.identifier.value
                                Definition

                                The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                ShortThe value that is unique
                                Comments

                                If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

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

                                Time period during which identifier is/was valid for use.

                                ShortTime period when id is/was valid for use
                                Control0..1
                                TypePeriod
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                64. Specimen.identifier.assigner
                                Definition

                                Organization that issued/manages the identifier.

                                ShortOrganization that issued id (may be just text)
                                Comments

                                The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                Control0..1
                                TypeReference(Organization)
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                66. 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
                                Must Supportfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                68. Specimen.accessionIdentifier.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
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                70. Specimen.accessionIdentifier.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.accessionIdentifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 72. Specimen.accessionIdentifier.extension:accessionIdentifier
                                  Slice NameaccessionIdentifier
                                  Definition

                                  STU3: Specimen.accessionIdentifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                  ShortSTU3: accessionIdentifier additional types
                                  Comments

                                  Element Specimen.accessionIdentifier is mapped to FHIR R4B element Specimen.accessionIdentifier as SourceIsBroaderThanTarget. The mappings for Specimen.accessionIdentifier do not cover the following types: Identifier. The mappings for Specimen.accessionIdentifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                  Control0..1
                                  TypeExtension(STU3: accessionIdentifier additional types) (Extension Type: Identifier)
                                  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.accessionIdentifier.use
                                  Definition

                                  The purpose of this identifier.

                                  Shortusual | official | temp | secondary | old (If known)
                                  Comments

                                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                  Control0..1
                                  BindingThe codes SHALL be taken from IdentifierUse
                                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
                                  Typecode
                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

                                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                  ShortDescription of identifier
                                  Comments

                                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                  Control0..1
                                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.3.0)
                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Allows users to make use of identifiers when the identifier system is not known.

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

                                  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                  ShortThe namespace for the identifier value
                                  Comments

                                  Identifier.system is always case sensitive.

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

                                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                  ExampleGeneral: http://www.acme.com/identifiers/patient
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  80. Specimen.accessionIdentifier.value
                                  Definition

                                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                  ShortThe value that is unique
                                  Comments

                                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

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

                                  Time period during which identifier is/was valid for use.

                                  ShortTime period when id is/was valid for use
                                  Control0..1
                                  TypePeriod
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  84. Specimen.accessionIdentifier.assigner
                                  Definition

                                  Organization that issued/manages the identifier.

                                  ShortOrganization that issued id (may be just text)
                                  Comments

                                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                  Control0..1
                                  TypeReference(Organization)
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  86. 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.3.0)

                                  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
                                  Must Supportfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  88. 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
                                  Must Supportfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  90. 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
                                  Must Supportfalse
                                  Summarytrue
                                  Requirements

                                  Must know the subject context.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  92. 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
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  94. Specimen.subject.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.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 96. Specimen.subject.extension:subject
                                    Slice Namesubject
                                    Definition

                                    STU3: Specimen.subject

                                    ShortSTU3: Where the specimen came from. This may be from the patient(s) or from the environment or a device
                                    Comments

                                    Element Specimen.subject is mapped to FHIR R4B element Specimen.subject as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.subject with unmapped reference targets: Device, Group, Patient, Substance.

                                    Control1..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())
                                    98. 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()))
                                    100. 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.3.0)
                                    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()))
                                    102. 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()))
                                    104. 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()))
                                    106. 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
                                    Must Supportfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    108. 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
                                    Must Supportfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    110. Specimen.parent.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
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    112. Specimen.parent.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.parent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 114. Specimen.parent.extension:parent
                                      Slice Nameparent
                                      Definition

                                      STU3: Specimen.parent additional types from child elements (display, identifier, reference)

                                      ShortSTU3: parent additional types
                                      Comments

                                      Element Specimen.parent is mapped to FHIR R4B element Specimen.parent as SourceIsBroaderThanTarget. The mappings for Specimen.parent do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.parent with unmapped reference targets: Specimen. 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..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())
                                      116. Specimen.parent.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()))
                                      118. Specimen.parent.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.3.0)
                                      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()))
                                      120. Specimen.parent.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()))
                                      122. Specimen.parent.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()))
                                      124. 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
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      126. Specimen.request.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
                                      Typeid
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      128. Specimen.request.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.request.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 130. Specimen.request.extension:request
                                        Slice Namerequest
                                        Definition

                                        STU3: Specimen.request additional types from child elements (display, identifier, reference)

                                        ShortSTU3: request additional types
                                        Comments

                                        Element Specimen.request is mapped to FHIR R4B element Specimen.request as RelatedTo. The mappings for Specimen.request do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.request with unmapped reference targets: ProcedureRequest. The request may be explicit or implied such with a ProcedureRequest that requires a blood draw.

                                        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())
                                        132. Specimen.request.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()))
                                        134. Specimen.request.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.3.0)
                                        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()))
                                        136. Specimen.request.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()))
                                        138. Specimen.request.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()))
                                        140. Specimen.collection
                                        Definition

                                        Details concerning the specimen collection.

                                        ShortCollection details
                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                        142. 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
                                        144. Specimen.collection.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())
                                        146. 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())
                                        148. Specimen.collection.collector
                                        Definition

                                        Person who collected the specimen.

                                        ShortWho collected the specimen
                                        Control0..1
                                        TypeReference(Practitioner, PractitionerRole)
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        150. 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
                                        Typeid
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        152. 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
                                        • 154. Specimen.collection.collector.extension:collector
                                          Slice Namecollector
                                          Definition

                                          STU3: Specimen.collection.collector additional types from child elements (display, identifier, reference)

                                          ShortSTU3: collector additional types
                                          Comments

                                          Element Specimen.collection.collector is mapped to FHIR R4B element Specimen.collection.collector as SourceIsBroaderThanTarget. The mappings for Specimen.collection.collector do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.collection.collector with unmapped reference targets: Practitioner.

                                          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())
                                          156. 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()))
                                          158. 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.3.0)
                                          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()))
                                          160. 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()))
                                          162. 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()))
                                          164. 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
                                          Must Supportfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          166. 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
                                          Must Supportfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          168. 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
                                          Must Supportfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          170. 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.3.0)

                                          The technique that is used to perform the procedure.

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          172. 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.3.0)

                                          SNOMED CT Body site concepts

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          174. 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
                                          Must Supportfalse
                                          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()))
                                          176. Specimen.processing
                                          Definition

                                          Details concerning processing and processing steps for the specimen.

                                          ShortProcessing and processing step details
                                          Control0..*
                                          TypeBackboneElement
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                          178. 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
                                          180. 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())
                                          182. 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())
                                          184. 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
                                          Must Supportfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          186. 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.3.0)

                                          Type indicating the technique used to process the specimen.

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

                                          Material used in the processing step.

                                          ShortMaterial used in the processing step
                                          Control0..*
                                          TypeReference(Substance)
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          190. Specimen.processing.additive.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
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          192. Specimen.processing.additive.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.processing.additive.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 194. Specimen.processing.additive.extension:additive
                                            Slice Nameadditive
                                            Definition

                                            STU3: Specimen.processing.additive additional types from child elements (display, identifier, reference)

                                            ShortSTU3: additive additional types
                                            Comments

                                            Element Specimen.processing.additive is mapped to FHIR R4B element Specimen.processing.additive as SourceIsBroaderThanTarget. The mappings for Specimen.processing.additive do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.processing.additive with unmapped reference targets: Substance.

                                            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())
                                            196. Specimen.processing.additive.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()))
                                            198. Specimen.processing.additive.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.3.0)
                                            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()))
                                            200. Specimen.processing.additive.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()))
                                            202. Specimen.processing.additive.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()))
                                            204. 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
                                            Must Supportfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            206. 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
                                            Must Supportfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                            208. 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
                                            210. Specimen.container.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())
                                            212. 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())
                                            214. 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
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            216. Specimen.container.identifier.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
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            218. Specimen.container.identifier.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.container.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 220. Specimen.container.identifier.extension:identifier
                                              Slice Nameidentifier
                                              Definition

                                              STU3: Specimen.container.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                              ShortSTU3: identifier additional types
                                              Comments

                                              Element Specimen.container.identifier is mapped to FHIR R4B element Specimen.container.identifier as SourceIsBroaderThanTarget. The mappings for Specimen.container.identifier do not cover the following types: Identifier. The mappings for Specimen.container.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                              Control0..*
                                              TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
                                              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())
                                              222. Specimen.container.identifier.use
                                              Definition

                                              The purpose of this identifier.

                                              Shortusual | official | temp | secondary | old (If known)
                                              Comments

                                              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                              Control0..1
                                              BindingThe codes SHALL be taken from IdentifierUse
                                              (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
                                              Typecode
                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              224. Specimen.container.identifier.type
                                              Definition

                                              A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                              ShortDescription of identifier
                                              Comments

                                              This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                              Control0..1
                                              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                              (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.3.0)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Summarytrue
                                              Requirements

                                              Allows users to make use of identifiers when the identifier system is not known.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              226. Specimen.container.identifier.system
                                              Definition

                                              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                              ShortThe namespace for the identifier value
                                              Comments

                                              Identifier.system is always case sensitive.

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

                                              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                              ExampleGeneral: http://www.acme.com/identifiers/patient
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              228. Specimen.container.identifier.value
                                              Definition

                                              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                              ShortThe value that is unique
                                              Comments

                                              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

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

                                              Time period during which identifier is/was valid for use.

                                              ShortTime period when id is/was valid for use
                                              Control0..1
                                              TypePeriod
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              232. Specimen.container.identifier.assigner
                                              Definition

                                              Organization that issued/manages the identifier.

                                              ShortOrganization that issued id (may be just text)
                                              Comments

                                              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                              Control0..1
                                              TypeReference(Organization)
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              234. 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
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              236. 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 SpecimenContainer
                                              (example to http://hl7.org/fhir/ValueSet/specimen-container-type|4.3.0)

                                              Type of specimen container.

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

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

                                              ShortContainer volume or size
                                              Control0..1
                                              TypeQuantity(SimpleQuantity)
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              240. 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
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              242. 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
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              244. Specimen.container.additive[x].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
                                              Typeid
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              246. Specimen.container.additive[x].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.container.additive[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 248. Specimen.container.additive[x].extension:alternateReference
                                                Slice NamealternateReference
                                                Definition

                                                STU3: Specimen.container.additive[x] additional types from child elements (display, identifier, reference)

                                                ShortSTU3: additive additional types
                                                Comments

                                                Element Specimen.container.additive[x] is mapped to FHIR R4B element Specimen.container.additive[x] as SourceIsBroaderThanTarget. The mappings for Specimen.container.additive[x] do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Specimen.container.additive[x] with unmapped reference targets: Substance. Source element Specimen.container.additive[x] has unmapped reference types. While the target element Specimen.container.additive[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                                                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())
                                                250. 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
                                                Must Supportfalse
                                                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()))
                                                252. 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
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                254. Specimen.note.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
                                                Typeid
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                256. Specimen.note.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.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 258. Specimen.note.extension:note
                                                  Slice Namenote
                                                  Definition

                                                  STU3: Specimen.note additional types (Annotation) additional types from child elements (author[x], text, time)

                                                  ShortSTU3: note additional types
                                                  Comments

                                                  Element Specimen.note is mapped to FHIR R4B element Specimen.note as SourceIsBroaderThanTarget. The mappings for Specimen.note do not cover the following types: Annotation. The mappings for Specimen.note do not cover the following types based on type expansion: author[x], text, time.

                                                  Control0..*
                                                  TypeExtension(STU3: note additional types) (Extension Type: Annotation)
                                                  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())
                                                  260. Specimen.note.author[x]
                                                  Definition

                                                  The individual responsible for making the annotation.

                                                  ShortIndividual responsible for the annotation
                                                  Comments

                                                  Organization is used when there's no need for specific attribution as to who made the comment.

                                                  Control0..1
                                                  TypeChoice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
                                                  [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()))
                                                  262. Specimen.note.time
                                                  Definition

                                                  Indicates when this particular annotation was made.

                                                  ShortWhen the annotation was made
                                                  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()))
                                                  264. Specimen.note.text
                                                  Definition

                                                  The text of the annotation in markdown format.

                                                  ShortThe annotation - text content (as markdown)
                                                  Control1..1
                                                  Typemarkdown
                                                  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()))