MyHealth@Eu Laboratory Report
0.1.0 - trial-use 150

This page is part of the MyHealth@Eu Laboratory Report (v0.0.1: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SpecimenEuObligations - Detailed Descriptions

Page standards status: Draft Maturity Level: 0

Definitions for the Specimen-obl-lab-myhealtheu resource profile.

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

0. Specimen
Definition

Laboratory specimen


A sample to be used for analysis.

ShortLaboratory SpecimenSample 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

If the specimen.type conveys information about the site the specimen has been collected from, then, if the bodySite if present it shall be coherent with the type.


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
BindingThe codes SHOULD be taken from For example codes, see Specimen Typeshttp://terminology.hl7.org/ValueSet/v2-0487
(preferred to http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-lab)
TypeCodeableConcept
Is Modifierfalse
Obligations
    ObligationsActor
    SHALL:handleLabReportConsumer
    SHOULD:populateLabReportRepos
    SHALL:able-to-populateLabReportCreator
    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: Person, Patient: Animal, Group, Device, Substance, Location, Patient)
    Is Modifierfalse
    Obligations
      ObligationsActor
      SHALL:handleLabReportConsumer
      SHOULD:populateLabReportRepos
      SHALL:able-to-populateLabReportCreator
      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

      If the specimen information are known when the order is created then the ServiceRequest.specimen should be used. If the ServiceRequest can be updated when the specimen is collected then the ServiceRequest.specimen or the Specimen.request could be used. Otherwise the relationship is recorded in the Specimen.request element


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

      Control0..*
      TypeReference(ServiceRequest)
      Is Modifierfalse
      Obligations
        ObligationsActor
        SHALL:handleLabReportConsumer
        SHALL:handleLabReportRepos
        SHALL:able-to-populateLabReportCreator
        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:handleLabReportConsumer
          SHOULD:populateLabReportRepos
          SHALL:able-to-populateLabReportCreator
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. Specimen.collection.extension:bodySite
          Slice NamebodySite
          Definition

          Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

          ShortTarget anatomic location or structure
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(BodyStructure Reference) (Extension Type: Reference(BodyStructure))
          Is Modifierfalse
          Obligations
            ObligationsActor
            SHALL:handleLabReportConsumer
            SHALL:handleLabReportRepos
            SHALL:able-to-populateLabReportCreator
            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())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            18. Specimen.collection.extension:bodySite.extension
            Definition

            An Extension


            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.

            ShortExtensionAdditional content defined by implementations
            Comments

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

            Control0..0*
            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())
            SlicingThis element introduces a set of slices on Specimen.collection.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 20. Specimen.collection.extension:bodySite.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/bodySite
              22. Specimen.collection.extension:bodySite.value[x]
              Definition

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              ShortValue of extension
              Control10..1
              TypeReference(Body structure: Laboratory), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
              [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()))
              24. 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())
              26. 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 specimen.type conveys information about the site the specimen has been collected from, then, if the bodySite if present it shall be coherent with the type


              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
              BindingThe codes SHOULD be taken from For example codes, see SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
              (preferred to http://hl7.org/fhir/ValueSet/body-site)
              TypeCodeableConcept
              Is Modifierfalse
              Obligations
                ObligationsActor
                SHALL:handleLabReportConsumer
                SHOULD:populateLabReportRepos
                SHALL:able-to-populateLabReportCreator
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                28. 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:handleLabReportConsumer
                  SHOULD:populateLabReportRepos
                  SHALL:able-to-populateLabReportCreator
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  30. Specimen.container.extension:device
                  Slice Namedevice
                  Definition

                  Optional Extension Element - found in all resources.

                  ShortOptional Extensions Element
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(Extension Definition for Specimen.container.device for Version 5.0) (Extension Type: Reference(Device))
                  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())
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  32. 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())
                  34. 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
                  BindingThe codes SHOULD be taken from For example codes, see Specimen Containerhttp://hl7.org/fhir/ValueSet/specimen-container-type
                  (preferred to http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Obligations
                    ObligationsActor
                    SHALL:handleLabReportConsumer
                    SHOULD:populateLabReportRepos
                    SHALL:able-to-populateLabReportCreator
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. Specimen.container.additive[x]
                    Definition

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

                    ShortAdditive associated with container
                    Control0..01
                    BindingFor example codes, see hl7VS-additivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371
                    (example to http://terminology.hl7.org/ValueSet/v2-0371)

                    Substance added to specimen container.

                    TypeChoice of: CodeableConcept, Reference(Substance)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))