Profile_R5_SpecimenDefinition_R4 - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1.0

Is Modifier false

Summary true

4. SpecimenDefinition.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.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. SpecimenDefinition.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.

Short A 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.

Control 0..1

uri

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. SpecimenDefinition.language

Definition

The base language in which the resource is written.

Short Language 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).

Control 0..1

The codes SHOULD be taken from CommonLanguages

(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. SpecimenDefinition.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.

Short Text 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.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. SpecimenDefinition.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.

Short Contained, 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.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. SpecimenDefinition.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

This element introduces a set of slices on SpecimenDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. SpecimenDefinition.extension:url

Slice Name url

Definition

R5: SpecimenDefinition.url (new:uri)

Short R5: Logical canonical URL to reference this SpecimenDefinition (globally unique) (new)

Comments

Element SpecimenDefinition.url has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.url has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.url: http://hl7.org/fhir/StructureDefinition/artifact-url. Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.

Control 0..1

Type Extension(Artifact URL) (Extension Type: uri)

Is Modifier false

Summary false

18. SpecimenDefinition.extension:version

Slice Name version

Definition

R5: SpecimenDefinition.version (new:string)

Short R5: Business version of the SpecimenDefinition (new)

Comments

Element SpecimenDefinition.version has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.version has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.version: http://hl7.org/fhir/StructureDefinition/artifact-version. There may be multiple different instances of a SpecimenDefinition that have the same identifier but different versions.

Control 0..1

Type Extension(ArtifactVersion) (Extension Type: string)

Is Modifier false

Summary false

20. SpecimenDefinition.extension:versionAlgorithm

Slice Name versionAlgorithm

Definition

R5: SpecimenDefinition.versionAlgorithm[x] (new:Coding, string)

Short R5: How to compare versions (new)

Comments

Element SpecimenDefinition.versionAlgorithm[x] has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.versionAlgorithm[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Control 0..1

Type Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)

Is Modifier false

Summary false

22. SpecimenDefinition.extension:name

Slice Name name

Definition

R5: SpecimenDefinition.name (new:string)

Short R5: Name for this {{title}} (computer friendly) (new)

Comments

Element SpecimenDefinition.name has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.name has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.name: http://hl7.org/fhir/StructureDefinition/artifact-name. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Control 0..1

Type Extension(ArtifactName) (Extension Type: string)

Is Modifier false

Summary false

24. SpecimenDefinition.extension:title

Slice Name title

Definition

R5: SpecimenDefinition.title (new:string)

Short R5: Name for this SpecimenDefinition (Human friendly) (new)

Comments

Element SpecimenDefinition.title has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.title has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.title: http://hl7.org/fhir/StructureDefinition/artifact-title.

Control 0..1

Type Extension(Artifact Title) (Extension Type: string)

Is Modifier false

Summary false

26. SpecimenDefinition.extension:derivedFromCanonical

Slice Name derivedFromCanonical

Definition

R5: SpecimenDefinition.derivedFromCanonical (new:canonical(SpecimenDefinition))

Short R5: Based on FHIR definition of another SpecimenDefinition (new)

Comments

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

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Based on FHIR definition of another SpecimenDefinition (new)) (Extension Type: canonical(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4, SpecimenDefinition))

Is Modifier false

Summary false

28. SpecimenDefinition.extension:derivedFromUri

Slice Name derivedFromUri

Definition

R5: SpecimenDefinition.derivedFromUri (new:uri)

Short R5: Based on external definition (new)

Comments

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

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Based on external definition (new)) (Extension Type: uri)

Is Modifier false

Summary false

30. SpecimenDefinition.extension:experimental

Slice Name experimental

Definition

R5: SpecimenDefinition.experimental (new:boolean)

Short R5: If this SpecimenDefinition is not for real usage (new)

Comments

Element SpecimenDefinition.experimental has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.experimental has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.experimental: http://hl7.org/fhir/StructureDefinition/artifact-experimental. Allows filtering of SpecimenDefinition that are appropriate for use vs. not.

Control 0..1

Type Extension(Artifact Experimental) (Extension Type: boolean)

Is Modifier false

Summary false

32. SpecimenDefinition.extension:subject

Slice Name subject

Definition

R5: SpecimenDefinition.subject[x] (new:CodeableConcept, Reference(Group))

Short R5: Type of subject for specimen collection (new)

Comments

Element SpecimenDefinition.subject[x] has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.subject[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Examples: person, animal, device, water ….

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Type of subject for specimen collection (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR R4, Group))

Is Modifier false

Summary false

34. SpecimenDefinition.extension:date

Slice Name date

Definition

R5: SpecimenDefinition.date (new:dateTime)

Short R5: Date status first applied (new)

Comments

Element SpecimenDefinition.date has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.date has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.date: http://hl7.org/fhir/StructureDefinition/artifact-date. See guidance around (not) making local changes to elements here.

Control 0..1

Type Extension(Artifact Date) (Extension Type: dateTime)

Is Modifier false

Summary false

36. SpecimenDefinition.extension:publisher

Slice Name publisher

Definition

R5: SpecimenDefinition.publisher (new:string)

Short R5: The name of the individual or organization that published the SpecimenDefinition (new)

Comments

Element SpecimenDefinition.publisher has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.publisher has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.publisher: http://hl7.org/fhir/StructureDefinition/artifact-publisher.

Control 0..1

Type Extension(Artifact Publisher) (Extension Type: string)

Is Modifier false

Summary false

38. SpecimenDefinition.extension:contact

Slice Name contact

Definition

R5: SpecimenDefinition.contact (new:ContactDetail)

Short R5: Contact details for the publisher (new)

Comments

Element SpecimenDefinition.contact has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.contact has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.contact: http://hl7.org/fhir/StructureDefinition/artifact-contact. May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Control 0..*

Type Extension(Artifact Contact) (Extension Type: ContactDetail)

Is Modifier false

Summary false

40. SpecimenDefinition.extension:description

Slice Name description

Definition

R5: SpecimenDefinition.description (new:markdown)

Short R5: Natural language description of the SpecimenDefinition (new)

Comments

Element SpecimenDefinition.description has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.description: http://hl7.org/fhir/StructureDefinition/artifact-description. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

Control 0..1

Type Extension(Artifact Description) (Extension Type: markdown)

Is Modifier false

Summary false

42. SpecimenDefinition.extension:useContext

Slice Name useContext

Definition

R5: SpecimenDefinition.useContext (new:UsageContext)

Short R5: Content intends to support these contexts (new)

Comments

Element SpecimenDefinition.useContext has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.useContext has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.useContext: http://hl7.org/fhir/StructureDefinition/artifact-useContext. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

Control 0..*

Type Extension(Artifact use context) (Extension Type: UsageContext)

Is Modifier false

Summary false

44. SpecimenDefinition.extension:jurisdiction

Slice Name jurisdiction

Definition

R5: SpecimenDefinition.jurisdiction (new:CodeableConcept)

Short R5: Intended jurisdiction for this SpecimenDefinition (if applicable) (new)

Comments

Element SpecimenDefinition.jurisdiction has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.jurisdiction has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Element SpecimenDefinition.jurisdiction has been flagged as deprecated. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Intended jurisdiction for this SpecimenDefinition (if applicable) (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

46. SpecimenDefinition.extension:purpose

Slice Name purpose

Definition

R5: SpecimenDefinition.purpose (new:markdown)

Short R5: Why this SpecimenDefinition is defined (new)

Comments

Element SpecimenDefinition.purpose has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.purpose has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.purpose: http://hl7.org/fhir/StructureDefinition/artifact-purpose. This element does not describe the usage of the SpecimenDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this SpecimenDefinition.

Control 0..1

Type Extension(Artifact Purpose) (Extension Type: markdown)

Is Modifier false

Summary false

48. SpecimenDefinition.extension:copyright

Slice Name copyright

Definition

R5: SpecimenDefinition.copyright (new:markdown)

Short R5: Use and/or publishing restrictions (new)

Comments

Element SpecimenDefinition.copyright has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.copyright has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.copyright: http://hl7.org/fhir/StructureDefinition/artifact-copyright.

Control 0..1

Type Extension(Artifact Copyright) (Extension Type: markdown)

Is Modifier false

Summary false

50. SpecimenDefinition.extension:copyrightLabel

Slice Name copyrightLabel

Definition

R5: SpecimenDefinition.copyrightLabel (new:string)

Short R5: Copyright holder and year(s) (new)

Comments

Element SpecimenDefinition.copyrightLabel has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.copyrightLabel has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Control 0..1

Type Extension(Artifact Copyright Label) (Extension Type: string)

Is Modifier false

Summary false

52. SpecimenDefinition.extension:approvalDate

Slice Name approvalDate

Definition

R5: SpecimenDefinition.approvalDate (new:date)

Short R5: When SpecimenDefinition was approved by publisher (new)

Comments

Element SpecimenDefinition.approvalDate has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.approvalDate has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.approvalDate: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate. The date may be more recent than the approval date because of minor changes / editorial corrections.

See guidance around (not) making local changes to elements here.

Control 0..1

Type Extension(Artifact Approval Date) (Extension Type: date)

Is Modifier false

Summary false

54. SpecimenDefinition.extension:lastReviewDate

Slice Name lastReviewDate

Definition

R5: SpecimenDefinition.lastReviewDate (new:date)

Short R5: The date on which the asset content was last reviewed by the publisher (new)

Comments

Element SpecimenDefinition.lastReviewDate has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.lastReviewDate has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.lastReviewDate: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate. If specified, this is usually after the approval date.

See guidance around (not) making local changes to elements here.

Control 0..1

Type Extension(Artifact Last Review Date) (Extension Type: date)

Is Modifier false

Summary false

56. SpecimenDefinition.extension:effectivePeriod

Slice Name effectivePeriod

Definition

R5: SpecimenDefinition.effectivePeriod (new:Period)

Short R5: The effective date range for the SpecimenDefinition (new)

Comments

Element SpecimenDefinition.effectivePeriod has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.effectivePeriod has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.effectivePeriod: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod. The effective period for a SpecimenDefinition determines when the content is applicable for usage and is independent of publication and review dates.

See guidance around (not) making local changes to elements here.

Control 0..1

Type Extension(Artifact Effective Period) (Extension Type: Period)

Is Modifier false

Summary false

58. SpecimenDefinition.modifierExtension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

This element introduces a set of slices on SpecimenDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

60. SpecimenDefinition.modifierExtension:status

Slice Name status

Definition

R5: SpecimenDefinition.status (new:code)

Short R5: draft | active | retired | unknown (new)

Comments

Element SpecimenDefinition.status has a context of SpecimenDefinition based on following the parent source element upwards and mapping to SpecimenDefinition. Element SpecimenDefinition.status has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SpecimenDefinition.status: http://hl7.org/fhir/StructureDefinition/artifact-status. A nominal state-transition diagram can be found in the Definition pattern documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

See guidance around (not) making local changes to elements here.

Control 1..1

Type Extension(Artifact Status) (Extension Type: code)

Is Modifier true because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration

Summary false

62. SpecimenDefinition.identifier

Definition

A business identifier associated with the kind of specimen.

Short Business identifier of a kind of specimen

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Identifier

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. SpecimenDefinition.typeCollected

Definition

The kind of material to be collected.

Short Kind of material to collect

Control 0..1

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

The type of the specimen to be collected.

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. SpecimenDefinition.patientPreparation

Definition

Preparation of the patient for specimen collection.

Short Patient preparation for collection

Control 0..*

For example codes, see PreparePatient
(example to http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection|4.0.1)

Checks on the patient prior specimen collection.

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

68. SpecimenDefinition.timeAspect

Definition

Time aspect of specimen collection (duration or offset).

Short Time aspect for collection

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 24 hour, 20' post charge

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. SpecimenDefinition.collection

Definition

The action to be performed for collecting the specimen.

Short Specimen collection procedure

Control 0..*

For example codes, see SpecimenCollection
(example to http://hl7.org/fhir/ValueSet/specimen-collection|4.0.1)

The action to collect a type of specimen.

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

72. SpecimenDefinition.typeTested

Definition

Specimen conditioned in a container as expected by the testing laboratory.

Short Specimen in container intended for testing by lab

Control 0..*

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

74. SpecimenDefinition.typeTested.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

76. SpecimenDefinition.typeTested.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on SpecimenDefinition.typeTested.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

78. SpecimenDefinition.typeTested.extension:singleUse

Slice Name singleUse

Definition

R5: SpecimenDefinition.typeTested.singleUse (new:boolean)

Short R5: Specimen for single use only (new)

Comments

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

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Specimen for single use only (new)) (Extension Type: boolean)

Is Modifier false

Summary false

80. SpecimenDefinition.typeTested.extension:testingDestination

Slice Name testingDestination

Definition

R5: SpecimenDefinition.typeTested.testingDestination (new:CodeableConcept)

Short R5: Where the specimen will be tested (new)

Comments

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

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Where the specimen will be tested (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

82. SpecimenDefinition.typeTested.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).

Short Extensions 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.

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

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 Names extensions, user content, modifiers

84. SpecimenDefinition.typeTested.isDerived

Definition

Primary of secondary specimen.

Short Primary or secondary specimen

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Example General: false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

86. SpecimenDefinition.typeTested.type

Definition

The kind of specimen conditioned for testing expected by lab.

Short Type of intended specimen

Control 0..1

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

The type of specimen conditioned in a container for lab testing.

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

88. SpecimenDefinition.typeTested.preference

Definition

The preference for this type of conditioned specimen.

Short preferred | alternate

Control 1..1

The codes SHALL be taken from SpecimenContainedPreference
(required to http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.1)

Degree of preference of a type of conditioned specimen.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Example General: preferred, alternate

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

90. SpecimenDefinition.typeTested.container

Definition

The specimen's container.

Short The specimen's container

Control 0..1

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

92. SpecimenDefinition.typeTested.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.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

94. SpecimenDefinition.typeTested.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.

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

96. SpecimenDefinition.typeTested.container.modifierExtension

Definition

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

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

98. SpecimenDefinition.typeTested.container.material

Definition

The type of material of the container.

Short Container material

Control 0..1

For example codes, see ContainerMaterials
(example to http://hl7.org/fhir/ValueSet/container-material|4.0.1)

Types of material for specimen containers.

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

100. SpecimenDefinition.typeTested.container.type

Definition

The type of container used to contain this kind of specimen.

Short Kind of container associated with the kind of specimen

Control 0..1

For example codes, see SpecimenContainerType
(example to http://hl7.org/fhir/ValueSet/specimen-container-type|4.0.1)

Type of specimen container.

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

102. SpecimenDefinition.typeTested.container.cap

Definition

Color of container cap.

Short Color of container cap

Control 0..1

For example codes, see ContainerCap
(example to http://hl7.org/fhir/ValueSet/container-cap|4.0.1)

Color of the container cap.

Is Modifier false

Summary false

Requirements

From ISO 6710-2017 Table F.1 Recommended colour codes.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

104. SpecimenDefinition.typeTested.container.description

Definition

The textual description of the kind of container.

Short Container description

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Example General: Blue top tube with citrate

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

106. SpecimenDefinition.typeTested.container.capacity

Definition

The capacity (volume or other measure) of this kind of container.

Short Container capacity

Control 0..1

Type Quantity(SimpleQuantity)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

108. SpecimenDefinition.typeTested.container.minimumVolume[x]

Definition

The minimum volume to be conditioned in the container.

Short Minimum volume

Control 0..1

Type Choice of: Quantity(SimpleQuantity), string

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

110. SpecimenDefinition.typeTested.container.additive

Definition

Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Short Additive associated with container

Control 0..*

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

112. SpecimenDefinition.typeTested.container.additive.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

114. SpecimenDefinition.typeTested.container.additive.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

116. SpecimenDefinition.typeTested.container.additive.modifierExtension

Definition

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

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

118. SpecimenDefinition.typeTested.container.additive.additive[x]

Definition

Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Short Additive associated with container

Control 1..1

For example codes, see Hl7VSAdditivePreservative (3.0.0)
(example to http://terminology.hl7.org/ValueSet/v2-0371|3.0.0)

Substance added to specimen container.

Type Choice of: CodeableConcept, Reference(Substance)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

120. SpecimenDefinition.typeTested.container.additive.additive[x].id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

122. SpecimenDefinition.typeTested.container.additive.additive[x].extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on SpecimenDefinition.typeTested.container.additive.additive[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

124. SpecimenDefinition.typeTested.container.additive.additive[x].extension:alternateReference

Slice Name alternateReference

Definition

R5: SpecimenDefinition.typeTested.container.additive.additive[x] additional types from child elements (display, identifier, reference, type)

Short R5: additive additional types

Comments

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

Control 0..1

Type Extension(Alternate Reference) (Extension Type: Reference(Resource))

Is Modifier false

Summary false

126. SpecimenDefinition.typeTested.container.preparation

Definition

Special processing that should be applied to the container for this kind of specimen.

Short Specimen container preparation

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

128. SpecimenDefinition.typeTested.requirement

Definition

Requirements for delivery and special handling of this kind of conditioned specimen.

Short Specimen requirements

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

130. SpecimenDefinition.typeTested.retentionTime

Definition

The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.

Short Specimen retention time

Control 0..1

Duration

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

132. SpecimenDefinition.typeTested.rejectionCriterion

Definition

Criterion for rejection of the specimen in its container by the laboratory.

Short Rejection criterion

Control 0..*

For example codes, see RejectionCriterion
(example to http://hl7.org/fhir/ValueSet/rejection-criteria|4.0.1)

Criterion for rejection of the specimen by laboratory.

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

134. SpecimenDefinition.typeTested.handling

Definition

Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.

Short Specimen handling before testing

Control 0..*

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

136. SpecimenDefinition.typeTested.handling.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

138. SpecimenDefinition.typeTested.handling.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

140. SpecimenDefinition.typeTested.handling.modifierExtension

Definition

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

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

142. SpecimenDefinition.typeTested.handling.temperatureQualifier

Definition

It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.

Short Temperature qualifier

Control 0..1

For example codes, see HandlingConditionSet
(example to http://hl7.org/fhir/ValueSet/handling-condition|4.0.1)

Set of handling instructions prior testing of the specimen.

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

144. SpecimenDefinition.typeTested.handling.temperatureRange

Definition

The temperature interval for this set of handling instructions.

Short Temperature range

Control 0..1

Range

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

146. SpecimenDefinition.typeTested.handling.maxDuration

Definition

The maximum time interval of preservation of the specimen with these conditions.

Short Maximum preservation time

Control 0..1

Duration

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

148. SpecimenDefinition.typeTested.handling.instruction

Definition

Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.

Short Preservation instruction

Control 0..1