German Oncological Data Standard (GOLD)
0.1.0 - CI Build
German Oncological Data Standard (GOLD) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/tumor-specimen | Version: 0.1.0 | |||
Draft as of 2023-12-13 | Computable Name: TumorSpecimen | |||
Copyright/Legal: CC-BY-SA-4.0 |
Profile of a tumor specimen
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ProfileSpecimenBioprobeCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ProfileSpecimenBioprobeCore | Sample for analysis | |
partOf | S | 0..* | Reference(Profile Tumor) | Specimen part of Tumor URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/part-of |
identifier | 1..* | Identifier | External Identifier | |
collection | ||||
bodySite | 1..1 | CodeableConcept | Anatomical collection site | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ProfileSpecimenBioprobeCore | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
partOf | S | 0..* | Reference(Profile Tumor) | Specimen part of Tumor URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/part-of |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | SΣ | 1..* | Identifier | External Identifier |
status | ?!SΣ | 1..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
coding:sct | ΣN | 1..* | Coding | Code defined by a terminology system Binding: ValueSet - Probenart (extensible) |
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
subject | SΣC | 1..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 |
parent | SC | 0..* | Reference(Specimen) | Specimen from which this specimen originated |
request | SC | 0..* | Reference(ServiceRequest) | Why the specimen was collected |
collection | S | 1..1 | BackboneElement | Collection details |
einstellungBlutversorgung | SN | 0..1 | dateTime | Extension - Einstellung Blutversorgung URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/EinstellungBlutversorgung |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
collected[x] | SΣ | 1..1 | Collection time | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
bodySite | SC | 1..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
Slices for coding | ΣN | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
coding:sct | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - SNOMED CT Body Strutures (required) |
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
coding:icd-o-3 | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - ICD-O-3 Topography (required) |
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/icd-o-3 |
Slices for fastingStatus[x] | SΣN | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |
fastingStatusCodeableConcept | CodeableConcept | |||
fastingStatusDuration | Duration | |||
fastingStatus[x]:fastingStatusCodeableConcept | ΣN | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required): Codes describing the fasting status of the patient. |
Slices for processing | SN | 0..* | BackboneElement | Processing and processing step details Slice: Unordered, Open by pattern:processing.procedure.coding |
processing:All Slices | Content/Rules for all slices | |||
Slices for extension | N | 1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen |
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
procedure | SN | 1..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: ValueSet - SNOMED CT Laboratory Procedure (example): Type indicating the technique used to process the specimen. |
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
coding:sct | SΣN | 1..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
additive | SCN | 0..* | Reference(Profile - Substance - Additiv) | Material used in the processing step |
Slices for time[x] | SN | 0..1 | Date and time of specimen processing Slice: Unordered, Open by type:$this | |
timeDateTime | dateTime | |||
timePeriod | Period | |||
time[x]:timePeriod | SN | 0..1 | Period | Date and time of specimen processing |
start | SΣCN | 0..1 | dateTime | Starting time with inclusive boundary |
end | SΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
processing:lagerprozess | SN | 0..* | BackboneElement | Processing and processing step details |
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen |
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
time[x] | N | 1..1 | Period | Date and time of specimen processing |
time[x]:timePeriod | N | 0..1 | Period | Date and time of specimen processing |
start | ΣCN | 1..1 | dateTime | Starting time with inclusive boundary |
end | ΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
container | S | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Kind of container directly associated with specimen Binding: ValueSet - Containertyp (extensible): Type of specimen container. |
capacity | SC | 0..1 | SimpleQuantity | Container volume or size |
specimenQuantity | SC | 0..1 | SimpleQuantity | Quantity of specimen within container |
additive[x] | S | 0..1 | Reference(Profile - Substance - Additiv) | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.status | required | SpecimenStatus |
Specimen.type | example | Hl7VSSpecimenType |
Specimen.type.coding:sct | extensible | ValueSetProbenart |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
Specimen.collection.bodySite.coding:sct | required | ValueSetSCTBodyStructures |
Specimen.collection.bodySite.coding:icd-o-3 | required | ValueSetICDO3Topography |
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation |
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | Hl7VSRelevantClincialInformation |
Specimen.processing.procedure | example | ValueSetSCTLaboratoryProcedure |
Specimen.container.type | extensible | ValueSetContainertyp |
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative |
Id | Grade | Path(s) | Details | Requirements |
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | 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() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mii-bb-1 | error | Specimen.collection.bodySite | Bei der Angabe der Entnahmestelle muss ein ICD-O-3 Topographiecode oder ein SNOMED CT Code angegeben werden. : coding.where(system = 'http://snomed.info/sct' or system = 'http://terminology.hl7.org/CodeSystem/icd-o-3').exists() | |
qty-3 | error | Specimen.container.capacity, Specimen.container.specimenQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
ref-1 | error | Specimen.subject, Specimen.parent, Specimen.request, Specimen.processing.additive | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
sqty-1 | error | Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | ProfileSpecimenBioprobeCore | 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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
partOf | S | 0..* | Reference(Profile Tumor) | Specimen part of Tumor URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/part-of | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | SΣ | 1..* | Identifier | External Identifier | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
status | ?!SΣ | 1..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
coding:sct | ΣN | 1..* | Coding | Code defined by a terminology system Binding: ValueSet - Probenart (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | ΣN | 0..1 | string | Version of the system - if relevant | ||||
code | ΣN | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣN | 0..1 | string | Representation defined by the system | ||||
userSelected | ΣN | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣC | 1..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 | SC | 0..* | Reference(Specimen) | Specimen from which this specimen originated | ||||
request | SC | 0..* | Reference(ServiceRequest) | Why the specimen was collected | ||||
collection | S | 1..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
einstellungBlutversorgung | SN | 0..1 | dateTime | Extension - Einstellung Blutversorgung URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/EinstellungBlutversorgung | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | SΣ | 1..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | ΣC | 0..1 | Duration | How long it took to collect specimen Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration.
| ||||
quantity | C | 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 | SC | 1..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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
Slices for coding | ΣN | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
coding:sct | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - SNOMED CT Body Strutures (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | ΣN | 0..1 | string | Version of the system - if relevant | ||||
code | ΣN | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣN | 0..1 | string | Representation defined by the system | ||||
userSelected | ΣN | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:icd-o-3 | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - ICD-O-3 Topography (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/icd-o-3 | ||||
version | ΣN | 0..1 | string | Version of the system - if relevant | ||||
code | ΣN | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣN | 0..1 | string | Representation defined by the system | ||||
userSelected | ΣN | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for fastingStatus[x] | SΣN | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
fastingStatus[x]:fastingStatusCodeableConcept | ΣN | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required): Codes describing the fasting status of the patient. | ||||
Slices for processing | SN | 0..* | BackboneElement | Processing and processing step details Slice: Unordered, Open by pattern:processing.procedure.coding | ||||
processing:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen | ||||
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | N | 0..1 | string | Textual description of procedure | ||||
procedure | SN | 1..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: ValueSet - SNOMED CT Laboratory Procedure (example): Type indicating the technique used to process the specimen. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
coding:sct | SΣN | 1..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
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 | ΣN | 0..1 | string | Plain text representation of the concept | ||||
additive | SCN | 0..* | Reference(Profile - Substance - Additiv) | Material used in the processing step | ||||
Slices for time[x] | SN | 0..1 | Date and time of specimen processing Slice: Unordered, Open by type:$this | |||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
time[x]:timePeriod | SN | 0..1 | Period | Date and time of specimen processing | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
start | SΣCN | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
processing:lagerprozess | SN | 0..* | BackboneElement | Processing and processing step details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen | ||||
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | N | 0..1 | string | Textual description of procedure | ||||
procedure | N | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | ΣN | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1186936003 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | ΣN | 0..1 | string | Plain text representation of the concept | ||||
additive | CN | 0..* | Reference(Substance) | Material used in the processing step | ||||
time[x] | N | 1..1 | Period | Date and time of specimen processing | ||||
time[x]:timePeriod | N | 0..1 | Period | Date and time of specimen processing | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
start | ΣCN | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | ΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
container | S | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
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 | S | 1..1 | CodeableConcept | Kind of container directly associated with specimen Binding: ValueSet - Containertyp (extensible): Type of specimen container. | ||||
capacity | SC | 0..1 | SimpleQuantity | Container volume or size | ||||
specimenQuantity | SC | 0..1 | SimpleQuantity | Quantity of specimen within container | ||||
additive[x] | S | 0..1 | Reference(Profile - Substance - Additiv) | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | S | 0..* | Annotation | Comments | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | Hl7VSSpecimenType | ||||
Specimen.type.coding:sct | extensible | ValueSetProbenart | ||||
Specimen.collection.duration | extensible | CommonUCUMCodesForDuration
| ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.bodySite.coding:sct | required | ValueSetSCTBodyStructures | ||||
Specimen.collection.bodySite.coding:icd-o-3 | required | ValueSetICDO3Topography | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | ValueSetSCTLaboratoryProcedure | ||||
Specimen.processing:lagerprozess.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | extensible | ValueSetContainertyp | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
Id | Grade | Path(s) | Details | Requirements |
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | 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() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
drt-1 | error | Specimen.collection.duration | There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. : code.exists() implies ((system = %ucum) and value.exists()) | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mii-bb-1 | error | Specimen.collection.bodySite | Bei der Angabe der Entnahmestelle muss ein ICD-O-3 Topographiecode oder ein SNOMED CT Code angegeben werden. : coding.where(system = 'http://snomed.info/sct' or system = 'http://terminology.hl7.org/CodeSystem/icd-o-3').exists() | |
qty-3 | error | Specimen.collection.duration, Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
ref-1 | error | Specimen.subject, Specimen.parent, Specimen.request, Specimen.collection.collector, Specimen.processing.additive, Specimen.processing:lagerprozess.additive | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from ProfileSpecimenBioprobeCore
Differential View
This structure is derived from ProfileSpecimenBioprobeCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ProfileSpecimenBioprobeCore | Sample for analysis | |
partOf | S | 0..* | Reference(Profile Tumor) | Specimen part of Tumor URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/part-of |
identifier | 1..* | Identifier | External Identifier | |
collection | ||||
bodySite | 1..1 | CodeableConcept | Anatomical collection site | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ProfileSpecimenBioprobeCore | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
partOf | S | 0..* | Reference(Profile Tumor) | Specimen part of Tumor URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/part-of |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | SΣ | 1..* | Identifier | External Identifier |
status | ?!SΣ | 1..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
coding:sct | ΣN | 1..* | Coding | Code defined by a terminology system Binding: ValueSet - Probenart (extensible) |
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
subject | SΣC | 1..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 |
parent | SC | 0..* | Reference(Specimen) | Specimen from which this specimen originated |
request | SC | 0..* | Reference(ServiceRequest) | Why the specimen was collected |
collection | S | 1..1 | BackboneElement | Collection details |
einstellungBlutversorgung | SN | 0..1 | dateTime | Extension - Einstellung Blutversorgung URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/EinstellungBlutversorgung |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
collected[x] | SΣ | 1..1 | Collection time | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
bodySite | SC | 1..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
Slices for coding | ΣN | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
coding:sct | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - SNOMED CT Body Strutures (required) |
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
coding:icd-o-3 | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - ICD-O-3 Topography (required) |
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/icd-o-3 |
Slices for fastingStatus[x] | SΣN | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |
fastingStatusCodeableConcept | CodeableConcept | |||
fastingStatusDuration | Duration | |||
fastingStatus[x]:fastingStatusCodeableConcept | ΣN | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required): Codes describing the fasting status of the patient. |
Slices for processing | SN | 0..* | BackboneElement | Processing and processing step details Slice: Unordered, Open by pattern:processing.procedure.coding |
processing:All Slices | Content/Rules for all slices | |||
Slices for extension | N | 1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen |
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
procedure | SN | 1..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: ValueSet - SNOMED CT Laboratory Procedure (example): Type indicating the technique used to process the specimen. |
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
coding:sct | SΣN | 1..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
additive | SCN | 0..* | Reference(Profile - Substance - Additiv) | Material used in the processing step |
Slices for time[x] | SN | 0..1 | Date and time of specimen processing Slice: Unordered, Open by type:$this | |
timeDateTime | dateTime | |||
timePeriod | Period | |||
time[x]:timePeriod | SN | 0..1 | Period | Date and time of specimen processing |
start | SΣCN | 0..1 | dateTime | Starting time with inclusive boundary |
end | SΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
processing:lagerprozess | SN | 0..* | BackboneElement | Processing and processing step details |
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen |
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
time[x] | N | 1..1 | Period | Date and time of specimen processing |
time[x]:timePeriod | N | 0..1 | Period | Date and time of specimen processing |
start | ΣCN | 1..1 | dateTime | Starting time with inclusive boundary |
end | ΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
container | S | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Kind of container directly associated with specimen Binding: ValueSet - Containertyp (extensible): Type of specimen container. |
capacity | SC | 0..1 | SimpleQuantity | Container volume or size |
specimenQuantity | SC | 0..1 | SimpleQuantity | Quantity of specimen within container |
additive[x] | S | 0..1 | Reference(Profile - Substance - Additiv) | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Path | Conformance | ValueSet |
Specimen.status | required | SpecimenStatus |
Specimen.type | example | Hl7VSSpecimenType |
Specimen.type.coding:sct | extensible | ValueSetProbenart |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
Specimen.collection.bodySite.coding:sct | required | ValueSetSCTBodyStructures |
Specimen.collection.bodySite.coding:icd-o-3 | required | ValueSetICDO3Topography |
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation |
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | Hl7VSRelevantClincialInformation |
Specimen.processing.procedure | example | ValueSetSCTLaboratoryProcedure |
Specimen.container.type | extensible | ValueSetContainertyp |
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative |
Id | Grade | Path(s) | Details | Requirements |
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | 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() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mii-bb-1 | error | Specimen.collection.bodySite | Bei der Angabe der Entnahmestelle muss ein ICD-O-3 Topographiecode oder ein SNOMED CT Code angegeben werden. : coding.where(system = 'http://snomed.info/sct' or system = 'http://terminology.hl7.org/CodeSystem/icd-o-3').exists() | |
qty-3 | error | Specimen.container.capacity, Specimen.container.specimenQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
ref-1 | error | Specimen.subject, Specimen.parent, Specimen.request, Specimen.processing.additive | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
sqty-1 | error | Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | ProfileSpecimenBioprobeCore | 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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
partOf | S | 0..* | Reference(Profile Tumor) | Specimen part of Tumor URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/part-of | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | SΣ | 1..* | Identifier | External Identifier | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
status | ?!SΣ | 1..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
coding:sct | ΣN | 1..* | Coding | Code defined by a terminology system Binding: ValueSet - Probenart (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | ΣN | 0..1 | string | Version of the system - if relevant | ||||
code | ΣN | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣN | 0..1 | string | Representation defined by the system | ||||
userSelected | ΣN | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣC | 1..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 | SC | 0..* | Reference(Specimen) | Specimen from which this specimen originated | ||||
request | SC | 0..* | Reference(ServiceRequest) | Why the specimen was collected | ||||
collection | S | 1..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
einstellungBlutversorgung | SN | 0..1 | dateTime | Extension - Einstellung Blutversorgung URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/EinstellungBlutversorgung | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | SΣ | 1..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | ΣC | 0..1 | Duration | How long it took to collect specimen Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration.
| ||||
quantity | C | 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 | SC | 1..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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
Slices for coding | ΣN | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
coding:sct | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - SNOMED CT Body Strutures (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | ΣN | 0..1 | string | Version of the system - if relevant | ||||
code | ΣN | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣN | 0..1 | string | Representation defined by the system | ||||
userSelected | ΣN | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:icd-o-3 | SΣN | 0..1 | Coding | Code defined by a terminology system Binding: ValueSet - ICD-O-3 Topography (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | ΣN | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/icd-o-3 | ||||
version | ΣN | 0..1 | string | Version of the system - if relevant | ||||
code | ΣN | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣN | 0..1 | string | Representation defined by the system | ||||
userSelected | ΣN | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for fastingStatus[x] | SΣN | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
fastingStatus[x]:fastingStatusCodeableConcept | ΣN | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (required): Codes describing the fasting status of the patient. | ||||
Slices for processing | SN | 0..* | BackboneElement | Processing and processing step details Slice: Unordered, Open by pattern:processing.procedure.coding | ||||
processing:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen | ||||
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | N | 0..1 | string | Textual description of procedure | ||||
procedure | SN | 1..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: ValueSet - SNOMED CT Laboratory Procedure (example): Type indicating the technique used to process the specimen. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
coding:sct | SΣN | 1..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
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 | ΣN | 0..1 | string | Plain text representation of the concept | ||||
additive | SCN | 0..* | Reference(Profile - Substance - Additiv) | Material used in the processing step | ||||
Slices for time[x] | SN | 0..1 | Date and time of specimen processing Slice: Unordered, Open by type:$this | |||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
time[x]:timePeriod | SN | 0..1 | Period | Date and time of specimen processing | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
start | SΣCN | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
processing:lagerprozess | SN | 0..* | BackboneElement | Processing and processing step details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
temperaturbedingungen | SN | 1..1 | Range | Extension - Temperaturbedingungen URL: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Temperaturbedingungen | ||||
modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | N | 0..1 | string | Textual description of procedure | ||||
procedure | N | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | ΣN | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1186936003 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | ΣN | 0..1 | string | Plain text representation of the concept | ||||
additive | CN | 0..* | Reference(Substance) | Material used in the processing step | ||||
time[x] | N | 1..1 | Period | Date and time of specimen processing | ||||
time[x]:timePeriod | N | 0..1 | Period | Date and time of specimen processing | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
start | ΣCN | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | ΣCN | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
container | S | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
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 | S | 1..1 | CodeableConcept | Kind of container directly associated with specimen Binding: ValueSet - Containertyp (extensible): Type of specimen container. | ||||
capacity | SC | 0..1 | SimpleQuantity | Container volume or size | ||||
specimenQuantity | SC | 0..1 | SimpleQuantity | Quantity of specimen within container | ||||
additive[x] | S | 0..1 | Reference(Profile - Substance - Additiv) | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | S | 0..* | Annotation | Comments | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | Hl7VSSpecimenType | ||||
Specimen.type.coding:sct | extensible | ValueSetProbenart | ||||
Specimen.collection.duration | extensible | CommonUCUMCodesForDuration
| ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.bodySite.coding:sct | required | ValueSetSCTBodyStructures | ||||
Specimen.collection.bodySite.coding:icd-o-3 | required | ValueSetICDO3Topography | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | ValueSetSCTLaboratoryProcedure | ||||
Specimen.processing:lagerprozess.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | extensible | ValueSetContainertyp | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
Id | Grade | Path(s) | Details | Requirements |
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | 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() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
drt-1 | error | Specimen.collection.duration | There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. : code.exists() implies ((system = %ucum) and value.exists()) | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mii-bb-1 | error | Specimen.collection.bodySite | Bei der Angabe der Entnahmestelle muss ein ICD-O-3 Topographiecode oder ein SNOMED CT Code angegeben werden. : coding.where(system = 'http://snomed.info/sct' or system = 'http://terminology.hl7.org/CodeSystem/icd-o-3').exists() | |
qty-3 | error | Specimen.collection.duration, Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
ref-1 | error | Specimen.subject, Specimen.parent, Specimen.request, Specimen.collection.collector, Specimen.processing.additive, Specimen.processing:lagerprozess.additive | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |