Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Specimen | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_Specimen_R3 | ||
This cross-version profile allows R5 Specimen content to be represented via FHIR STU3 Specimen resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Specimen |
0..* | Specimen | Sample for analysis | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:combined |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR3 (0.1.0) (required): Codes for the combined status of a specimen. | |
| extension:role |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR3 (0.1.0) (preferred): Codes describing specimen role. | |
| extension:feature |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature | |
 extension:condition |
0..* | CodeableConcept | R5: State of the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.condition Binding: v2 Specimen Condition (extensible): Codes describing the state of the specimen. | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
  subject |
Σ | 1..1 | Reference(Patient | Group | Device | Substance) | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Specimen | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:combined |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR3 (0.1.0) (required): Codes for the combined status of a specimen. | |
| extension:role |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR3 (0.1.0) (preferred): Codes describing specimen role. | |
| extension:feature |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature | |
| extension:condition |
0..* | CodeableConcept | R5: State of the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.condition Binding: v2 Specimen Condition (extensible): Codes describing the state of the specimen. | |
 subject |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| parent |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:parent |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: parent additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| request |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:request |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| collection |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:duration |
0..1 | Duration | R5: How long it took to collect specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.duration | |
| extension:device |
0..1 | (Complex) | R5: Device used to perform collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.device | |
| extension:procedure |
0..1 | Reference(Cross-version Profile for R5.Procedure for use in FHIR STU3(0.1.0) | Procedure) | R5: The procedure that collects the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.procedure | |
| extension:fastingStatus |
0..1 | CodeableConcept, Duration | R5: Whether or how long patient abstained from food and/or drink (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.fastingStatus Binding: v2 Relevant Clincial Information (extensible): Codes describing the fasting status of the patient. | |
| collector |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:collector |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: collector URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| bodySite |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:bodySite |
0..1 | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: bodySite additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite | |
| processing |
||||
| additive |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:additive |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| container |
||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:device |
1..1 | Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) | R5: Device resource for the container (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location) | R5: Where the container is (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages  (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:combined |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR3 (0.1.0) (required): Codes for the combined status of a specimen. | |||||
| extension:role |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR3 (0.1.0) (preferred): Codes describing specimen role. | |||||
| extension:feature |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature | |||||
| extension:condition |
0..* | CodeableConcept | R5: State of the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.condition Binding: v2 Specimen Condition (extensible): Codes describing the state of the specimen. | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Identifier | ||||
| accessionIdentifier |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example): The type of the specimen. | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group | Device | Substance) | Where the specimen came from. This may be from the patient(s) or from the environment or a device | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
 display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| receivedTime |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:parent |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: parent additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| request |
0..* | Reference(ProcedureRequest) | Why the specimen was collected | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:request |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| collection |
0..1 | BackboneElement | Collection details | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:duration |
0..1 | Duration | R5: How long it took to collect specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.duration | |||||
| extension:device |
0..1 | (Complex) | R5: Device used to perform collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.device | |||||
| extension:procedure |
0..1 | Reference(Cross-version Profile for R5.Procedure for use in FHIR STU3(0.1.0) | Procedure) | R5: The procedure that collects the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.procedure | |||||
| extension:fastingStatus |
0..1 | CodeableConcept, Duration | R5: Whether or how long patient abstained from food and/or drink (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.fastingStatus Binding: v2 Relevant Clincial Information (extensible): Codes describing the fasting status of the patient. | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| collector |
Σ | 0..1 | Reference(Practitioner) | Who collected the specimen | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:collector |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: collector URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
 collected[x] |
Σ | 0..1 | Collection time | |||||
| collectedDateTime |
dateTime | |||||||
| collectedPeriod |
Period | |||||||
| quantity |
0..1 | SimpleQuantity | The quantity of specimen collected | |||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example): The technique that is used to perform the procedure | |||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:bodySite |
0..1 | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: bodySite additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| processing |
0..* | BackboneElement | Processing and processing step details | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description |
0..1 | string | Textual description of procedure | |||||
| procedure |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen | |||||
| additive |
0..* | Reference(Substance) | Material used in the processing step | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:additive |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| time[x] |
0..1 | Date and time of specimen processing | ||||||
| timeDateTime |
dateTime | |||||||
| timePeriod |
Period | |||||||
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:device |
1..1 | Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) | R5: Device resource for the container (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location) | R5: Where the container is (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Id for the container | ||||
| description |
0..1 | string | Textual description of the container | |||||
| type |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example): Type of specimen container | |||||
| capacity |
0..1 | SimpleQuantity | Container volume or size | |||||
| specimenQuantity |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
| additive[x] |
0..1 | Additive associated with container Binding: v2 Additive/Preservative (example): Substance added to specimen container | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| note |
0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Specimen.status | Base | required | SpecimenStatus | 📍3.0.2 | FHIR Std. |
| Specimen.type | Base | example | v2 Specimen Type | 📍2.8.2 | FHIR Std. |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍3.0.2 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍3.0.2 | FHIR Std. |
| Specimen.processing.procedure | Base | example | SpecimenProcessingProcedure | 📍3.0.2 | FHIR Std. |
| Specimen.container.type | Base | example | SpecimenContainer | 📍3.0.2 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | v2 Additive/Preservative | 📍2.8.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Specimen | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Specimen
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:combined |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR3 (0.1.0) (required): Codes for the combined status of a specimen. | |
| extension:role |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR3 (0.1.0) (preferred): Codes describing specimen role. | |
| extension:feature |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature | |
| extension:condition |
0..* | CodeableConcept | R5: State of the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.condition Binding: v2 Specimen Condition (extensible): Codes describing the state of the specimen. | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
| subject |
Σ | 1..1 | Reference(Patient | Group | Device | Substance) | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Specimen | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:combined |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR3 (0.1.0) (required): Codes for the combined status of a specimen. | |
| extension:role |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR3 (0.1.0) (preferred): Codes describing specimen role. | |
| extension:feature |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature | |
| extension:condition |
0..* | CodeableConcept | R5: State of the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.condition Binding: v2 Specimen Condition (extensible): Codes describing the state of the specimen. | |
| subject |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| parent |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:parent |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: parent additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| request |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:request |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| collection |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:duration |
0..1 | Duration | R5: How long it took to collect specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.duration | |
| extension:device |
0..1 | (Complex) | R5: Device used to perform collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.device | |
| extension:procedure |
0..1 | Reference(Cross-version Profile for R5.Procedure for use in FHIR STU3(0.1.0) | Procedure) | R5: The procedure that collects the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.procedure | |
| extension:fastingStatus |
0..1 | CodeableConcept, Duration | R5: Whether or how long patient abstained from food and/or drink (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.fastingStatus Binding: v2 Relevant Clincial Information (extensible): Codes describing the fasting status of the patient. | |
| collector |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:collector |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: collector URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| bodySite |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:bodySite |
0..1 | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: bodySite additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite | |
| processing |
||||
| additive |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:additive |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| container |
||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:device |
1..1 | Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) | R5: Device resource for the container (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location) | R5: Where the container is (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:combined |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR3 (0.1.0) (required): Codes for the combined status of a specimen. | |||||
| extension:role |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR3 (0.1.0) (preferred): Codes describing specimen role. | |||||
| extension:feature |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature | |||||
| extension:condition |
0..* | CodeableConcept | R5: State of the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.condition Binding: v2 Specimen Condition (extensible): Codes describing the state of the specimen. | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Identifier | ||||
| accessionIdentifier |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example): The type of the specimen. | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group | Device | Substance) | Where the specimen came from. This may be from the patient(s) or from the environment or a device | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| receivedTime |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:parent |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: parent additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| request |
0..* | Reference(ProcedureRequest) | Why the specimen was collected | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:request |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| collection |
0..1 | BackboneElement | Collection details | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:duration |
0..1 | Duration | R5: How long it took to collect specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.duration | |||||
| extension:device |
0..1 | (Complex) | R5: Device used to perform collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.device | |||||
| extension:procedure |
0..1 | Reference(Cross-version Profile for R5.Procedure for use in FHIR STU3(0.1.0) | Procedure) | R5: The procedure that collects the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.procedure | |||||
| extension:fastingStatus |
0..1 | CodeableConcept, Duration | R5: Whether or how long patient abstained from food and/or drink (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.fastingStatus Binding: v2 Relevant Clincial Information (extensible): Codes describing the fasting status of the patient. | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| collector |
Σ | 0..1 | Reference(Practitioner) | Who collected the specimen | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:collector |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: collector URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| collected[x] |
Σ | 0..1 | Collection time | |||||
| collectedDateTime |
dateTime | |||||||
| collectedPeriod |
Period | |||||||
| quantity |
0..1 | SimpleQuantity | The quantity of specimen collected | |||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example): The technique that is used to perform the procedure | |||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:bodySite |
0..1 | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: bodySite additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| processing |
0..* | BackboneElement | Processing and processing step details | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description |
0..1 | string | Textual description of procedure | |||||
| procedure |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen | |||||
| additive |
0..* | Reference(Substance) | Material used in the processing step | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:additive |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| time[x] |
0..1 | Date and time of specimen processing | ||||||
| timeDateTime |
dateTime | |||||||
| timePeriod |
Period | |||||||
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:device |
1..1 | Reference(Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device) | R5: Device resource for the container (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location) | R5: Where the container is (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Id for the container | ||||
| description |
0..1 | string | Textual description of the container | |||||
| type |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example): Type of specimen container | |||||
| capacity |
0..1 | SimpleQuantity | Container volume or size | |||||
| specimenQuantity |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
| additive[x] |
0..1 | Additive associated with container Binding: v2 Additive/Preservative (example): Substance added to specimen container | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| note |
0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Specimen.status | Base | required | SpecimenStatus | 📍3.0.2 | FHIR Std. |
| Specimen.type | Base | example | v2 Specimen Type | 📍2.8.2 | FHIR Std. |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍3.0.2 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍3.0.2 | FHIR Std. |
| Specimen.processing.procedure | Base | example | SpecimenProcessingProcedure | 📍3.0.2 | FHIR Std. |
| Specimen.container.type | Base | example | SpecimenContainer | 📍3.0.2 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | v2 Additive/Preservative | 📍2.8.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Specimen | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Specimen
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change