HL7 Europe Hospital Discharge Report
1.0.0-ci-build - ci-build 150

HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions

Resource Profile: SpecimenEuObligations - Detailed Descriptions

Page standards status: Informative Maturity Level: 0

Definitions for the specimen-obl-eu-hdr resource profile.

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

0. Specimen
Definition

A sample to be used for analysis.

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

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

ShortA set of rules under which this content was created
Comments

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

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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
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())
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.0.1
(required to http://hl7.org/fhir/ValueSet/specimen-status|4.0.1)

Codes providing the status/availability of a specimen.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. 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 hl7VS-specimenTypehttp://terminology.hl7.org/ValueSet/v2-0487
(example to http://terminology.hl7.org/ValueSet/v2-0487)

The type of the specimen.

TypeCodeableConcept
Is Modifierfalse
Obligations
    ObligationsActor
    SHALL:handleHDRConsumer
    SHALL:able-to-populateHDRCreator
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. 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
    Obligations
      ObligationsActor
      SHALL:handleHDRConsumer
      SHALL:able-to-populateHDRCreator
      Summarytrue
      Requirements

      Must know the subject context.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. 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
      Obligations
        ObligationsActor
        SHALL:handleHDRConsumer
        SHOULD:able-to-populateHDRCreator
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. Specimen.collection
        Definition

        Details concerning the specimen collection.

        ShortCollection details
        Control0..1
        TypeBackboneElement
        Is Modifierfalse
        Obligations
          ObligationsActor
          SHALL:handleHDRConsumer
          SHALL:able-to-populateHDRCreator
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. 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())
          18. 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 SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site|4.0.1
          (example to http://hl7.org/fhir/ValueSet/body-site|4.0.1)

          Codes describing anatomical locations. May include laterality.

          TypeCodeableConcept
          Is Modifierfalse
          Obligations
            ObligationsActor
            SHALL:handleHDRConsumer
            SHALL:able-to-populateHDRCreator
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. 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
            Obligations
              ObligationsActor
              SHALL:handleHDRConsumer
              SHALL:able-to-populateHDRCreator
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              22. 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())
              24. 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 SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type|4.0.1
              (example to http://hl7.org/fhir/ValueSet/specimen-container-type|4.0.1)

              Type of specimen container.

              TypeCodeableConcept
              Is Modifierfalse
              Obligations
                ObligationsActor
                SHALL:handleHDRConsumer
                SHALL:able-to-populateHDRCreator
                Summaryfalse
                Invariantsele-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.type
                Obligations
                  ObligationsActor
                  SHALL:handleHDRConsumer
                  SHALL:able-to-populateHDRCreator
                  4. Specimen.subject
                  Obligations
                    ObligationsActor
                    SHALL:handleHDRConsumer
                    SHALL:able-to-populateHDRCreator
                    6. Specimen.request
                    Obligations
                      ObligationsActor
                      SHALL:handleHDRConsumer
                      SHOULD:able-to-populateHDRCreator
                      8. Specimen.collection
                      Obligations
                        ObligationsActor
                        SHALL:handleHDRConsumer
                        SHALL:able-to-populateHDRCreator
                        10. Specimen.collection.bodySite
                        Obligations
                          ObligationsActor
                          SHALL:handleHDRConsumer
                          SHALL:able-to-populateHDRCreator
                          12. Specimen.processing
                          14. Specimen.processing.additive
                          Obligations
                            ObligationsActor
                            SHALL:handleHDRConsumer
                            SHOULD:able-to-populateHDRCreator
                            16. Specimen.container
                            Obligations
                              ObligationsActor
                              SHALL:handleHDRConsumer
                              SHALL:able-to-populateHDRCreator
                              18. Specimen.container.type
                              Obligations
                                ObligationsActor
                                SHALL:handleHDRConsumer
                                SHALL:able-to-populateHDRCreator

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

                                0. Specimen
                                Definition

                                A sample to be used for analysis.

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

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

                                ShortLogical id of this artifact
                                Comments

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

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

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

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

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

                                ShortA set of rules under which this content was created
                                Comments

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

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

                                The base language in which the resource is written.

                                ShortLanguage of the resource content
                                Comments

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

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

                                A human language.

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

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

                                ShortText summary of the resource, for human interpretation
                                Comments

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

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

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

                                ShortContained, inline Resources
                                Comments

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

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

                                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
                                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())
                                16. Specimen.modifierExtension
                                Definition

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

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

                                ShortExtensions that cannot be ignored
                                Comments

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

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

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

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

                                Id for specimen.

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

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

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

                                The availability of the specimen.

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

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

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

                                Codes providing the status/availability of a specimen.

                                Typecode
                                Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                24. 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 hl7VS-specimenType
                                (example to http://terminology.hl7.org/ValueSet/v2-0487)

                                The type of the specimen.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Obligations
                                  ObligationsActor
                                  SHALL:handleHDRConsumer
                                  SHALL:able-to-populateHDRCreator
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  26. 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
                                  Obligations
                                    ObligationsActor
                                    SHALL:handleHDRConsumer
                                    SHALL:able-to-populateHDRCreator
                                    Summarytrue
                                    Requirements

                                    Must know the subject context.

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

                                    Time when specimen was received for processing or testing.

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

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

                                    ShortSpecimen from which this specimen originated
                                    Comments

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

                                    Control0..*
                                    TypeReference(Specimen)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    32. 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
                                    Obligations
                                      ObligationsActor
                                      SHALL:handleHDRConsumer
                                      SHOULD:able-to-populateHDRCreator
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      34. Specimen.collection
                                      Definition

                                      Details concerning the specimen collection.

                                      ShortCollection details
                                      Control0..1
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Obligations
                                        ObligationsActor
                                        SHALL:handleHDRConsumer
                                        SHALL:able-to-populateHDRCreator
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        36. 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
                                        38. 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())
                                        40. 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())
                                        42. Specimen.collection.collector
                                        Definition

                                        Person who collected the specimen.

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

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

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

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

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

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

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

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

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

                                        The technique that is used to perform the procedure.

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

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

                                        ShortAnatomical collection site
                                        Comments

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

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

                                        Codes describing anatomical locations. May include laterality.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Obligations
                                          ObligationsActor
                                          SHALL:handleHDRConsumer
                                          SHALL:able-to-populateHDRCreator
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          54. 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 hl7VS-relevantClincialInformation
                                          (extensible to http://terminology.hl7.org/ValueSet/v2-0916)

                                          Codes describing the fasting status of the patient.

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

                                          Many diagnostic tests require fasting to facilitate accurate interpretation.

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

                                          Details concerning processing and processing steps for the specimen.

                                          ShortProcessing and processing step details
                                          Control0..*
                                          TypeBackboneElement
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          58. 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
                                          60. 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())
                                          62. 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())
                                          64. Specimen.processing.description
                                          Definition

                                          Textual description of procedure.

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

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

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

                                          Type indicating the technique used to process the specimen.

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

                                          Material used in the processing step.

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

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

                                            ShortDate and time of specimen processing
                                            Control0..1
                                            TypeChoice of: dateTime, Period
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            72. 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
                                            Obligations
                                              ObligationsActor
                                              SHALL:handleHDRConsumer
                                              SHALL:able-to-populateHDRCreator
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              74. 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
                                              76. 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())
                                              78. 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())
                                              80. Specimen.container.identifier
                                              Definition

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

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

                                              Textual description of the container.

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

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

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

                                              Type of specimen container.

                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Obligations
                                                ObligationsActor
                                                SHALL:handleHDRConsumer
                                                SHALL:able-to-populateHDRCreator
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                86. Specimen.container.capacity
                                                Definition

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

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

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

                                                ShortQuantity of specimen within container
                                                Control0..1
                                                TypeQuantity(SimpleQuantity)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                90. 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 hl7VS-additivePreservative
                                                (example to http://terminology.hl7.org/ValueSet/v2-0371)

                                                Substance added to specimen container.

                                                TypeChoice of: CodeableConcept, Reference(Substance)
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                92. 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 hl7VS-specimenCondition
                                                (extensible to http://terminology.hl7.org/ValueSet/v2-0493)

                                                Codes describing the state of the specimen.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summarytrue
                                                Requirements

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

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

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

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