BBMRI.de/GBA Implementation Guide
1.2.0 - CI Build
BBMRI.de/GBA Implementation Guide - Local Development build (v1.2.0). See the Directory of published versions
Official URL: https://fhir.bbmri.de/StructureDefinition/Specimen | Version: 1.2.0 | |||
Active as of 2023-09-01 | Computable Name: Specimen |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
storageTemperature | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/StorageTemperature Binding: Storage Temperature (required) |
diagnosis | S | 0..* | CodeableConcept | Sample Diagnosis URL: https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis |
value[x] | ||||
coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system, value:version, value:$this | |
custodian | S | 0..1 | Reference(Collection) | Extension URL: https://fhir.bbmri.de/StructureDefinition/Custodian |
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Sample Material Type (required) |
subject | S | 0..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
collection | S | 0..1 | BackboneElement | Collection details |
collected[x] | S | 0..1 | dateTime | Collection time |
bodySite | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:icd-o-3-topography | S | 1..1 | Coding | ICD-O-3 Topography |
system | 0..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.19376.1.3.11.36 | |
fastingStatus[x] | S | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required) |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.type | required | SampleMaterialType (a valid code from Sample Material Type) |
Specimen.collection.fastingStatus[x] | required | Hl7VSRelevantClincialInformation |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
storageTemperature | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://fhir.bbmri.de/StructureDefinition/StorageTemperature Binding: Storage Temperature (required) |
diagnosis | S | 0..* | CodeableConcept | Sample Diagnosis URL: https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis |
extension | 0..0 | |||
url | 1..1 | uri | "https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis" | |
value[x] | C | 1..1 | CodeableConcept | Value of extension |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system, value:version, value:$this |
coding:icd-10-who | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-10 |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
coding:icd-10-gm | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
coding:icd-9 | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-9 |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
coding:no-icd | Σ | 0..* | Coding | Code defined by a terminology system Binding: other sample diagnosis (required) |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
custodian | S | 0..1 | Reference(Collection) | Extension URL: https://fhir.bbmri.de/StructureDefinition/Custodian |
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. |
type | SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Sample Material Type (required) |
subject | SΣ | 0..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
collection | S | 0..1 | BackboneElement | Collection details |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
collected[x] | SΣ | 0..1 | dateTime | Collection time |
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:icd-o-3-topography | SΣ | 1..1 | Coding | ICD-O-3 Topography |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.19376.1.3.11.36 |
fastingStatus[x] | SΣ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required) |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.extension:diagnosis.value[x].coding:no-icd | required | OtherSampleDiagnosis (a valid code from Other Sample Diagnosis) |
Specimen.status | required | SpecimenStatus |
Specimen.type | required | SampleMaterialType (a valid code from Sample Material Type) |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
Specimen.collection.fastingStatus[x] | required | Hl7VSRelevantClincialInformation |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
storageTemperature | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://fhir.bbmri.de/StructureDefinition/StorageTemperature Binding: Storage Temperature (required) | ||||
diagnosis | S | 0..* | CodeableConcept | Sample Diagnosis URL: https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis" | |||||
value[x] | C | 1..1 | CodeableConcept | Value of extension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system, value:version, value:$this | ||||
coding:icd-10-who | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-10 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:icd-10-gm | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:icd-9 | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-9 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:no-icd | Σ | 0..* | Coding | Code defined by a terminology system Binding: other sample diagnosis (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
custodian | S | 0..1 | Reference(Collection) | Extension URL: https://fhir.bbmri.de/StructureDefinition/Custodian | ||||
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 | SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Sample Material Type (required) | ||||
subject | SΣ | 0..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
collection | S | 0..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | SΣ | 0..1 | dateTime | Collection time | ||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:icd-o-3-topography | SΣ | 1..1 | Coding | ICD-O-3 Topography | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.19376.1.3.11.36 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
fastingStatus[x] | SΣ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required) | ||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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: SpecimenContainerType (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: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.extension:diagnosis.value[x].coding:no-icd | required | OtherSampleDiagnosis (a valid code from Other Sample Diagnosis) | ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | required | SampleMaterialType (a valid code from Sample Material Type) | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.fastingStatus[x] | required | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | example | SpecimenContainerType | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
This structure is derived from Specimen
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
storageTemperature | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/StorageTemperature Binding: Storage Temperature (required) |
diagnosis | S | 0..* | CodeableConcept | Sample Diagnosis URL: https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis |
value[x] | ||||
coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system, value:version, value:$this | |
custodian | S | 0..1 | Reference(Collection) | Extension URL: https://fhir.bbmri.de/StructureDefinition/Custodian |
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Sample Material Type (required) |
subject | S | 0..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
collection | S | 0..1 | BackboneElement | Collection details |
collected[x] | S | 0..1 | dateTime | Collection time |
bodySite | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:icd-o-3-topography | S | 1..1 | Coding | ICD-O-3 Topography |
system | 0..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.19376.1.3.11.36 | |
fastingStatus[x] | S | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required) |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.type | required | SampleMaterialType (a valid code from Sample Material Type) |
Specimen.collection.fastingStatus[x] | required | Hl7VSRelevantClincialInformation |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
storageTemperature | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://fhir.bbmri.de/StructureDefinition/StorageTemperature Binding: Storage Temperature (required) |
diagnosis | S | 0..* | CodeableConcept | Sample Diagnosis URL: https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis |
extension | 0..0 | |||
url | 1..1 | uri | "https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis" | |
value[x] | C | 1..1 | CodeableConcept | Value of extension |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system, value:version, value:$this |
coding:icd-10-who | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-10 |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
coding:icd-10-gm | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
coding:icd-9 | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-9 |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
coding:no-icd | Σ | 0..* | Coding | Code defined by a terminology system Binding: other sample diagnosis (required) |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
custodian | S | 0..1 | Reference(Collection) | Extension URL: https://fhir.bbmri.de/StructureDefinition/Custodian |
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. |
type | SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Sample Material Type (required) |
subject | SΣ | 0..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
collection | S | 0..1 | BackboneElement | Collection details |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
collected[x] | SΣ | 0..1 | dateTime | Collection time |
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:icd-o-3-topography | SΣ | 1..1 | Coding | ICD-O-3 Topography |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.19376.1.3.11.36 |
fastingStatus[x] | SΣ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required) |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.extension:diagnosis.value[x].coding:no-icd | required | OtherSampleDiagnosis (a valid code from Other Sample Diagnosis) |
Specimen.status | required | SpecimenStatus |
Specimen.type | required | SampleMaterialType (a valid code from Sample Material Type) |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
Specimen.collection.fastingStatus[x] | required | Hl7VSRelevantClincialInformation |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
storageTemperature | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://fhir.bbmri.de/StructureDefinition/StorageTemperature Binding: Storage Temperature (required) | ||||
diagnosis | S | 0..* | CodeableConcept | Sample Diagnosis URL: https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.bbmri.de/StructureDefinition/SampleDiagnosis" | |||||
value[x] | C | 1..1 | CodeableConcept | Value of extension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system, value:version, value:$this | ||||
coding:icd-10-who | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-10 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:icd-10-gm | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:icd-9 | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/icd-9 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:no-icd | Σ | 0..* | Coding | Code defined by a terminology system Binding: other sample diagnosis (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
custodian | S | 0..1 | Reference(Collection) | Extension URL: https://fhir.bbmri.de/StructureDefinition/Custodian | ||||
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 | SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Sample Material Type (required) | ||||
subject | SΣ | 0..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
collection | S | 0..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | SΣ | 0..1 | dateTime | Collection time | ||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:icd-o-3-topography | SΣ | 1..1 | Coding | ICD-O-3 Topography | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.19376.1.3.11.36 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
fastingStatus[x] | SΣ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required) | ||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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: SpecimenContainerType (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: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.extension:diagnosis.value[x].coding:no-icd | required | OtherSampleDiagnosis (a valid code from Other Sample Diagnosis) | ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | required | SampleMaterialType (a valid code from Sample Material Type) | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.fastingStatus[x] | required | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | example | SpecimenContainerType | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
This structure is derived from Specimen
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron