FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/onco-biological-sample | Version: 2.1.0 | |||
Draft as of 2024-03-21 | Computable Name: BiologicalSample |
Description of a biological sample coming from an oncology Patient, with its storage condition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Specimen | Sample for analysis | |
![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin Binding: Biological Sample Origin Value Set (extensible) |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The origin of the sample | |
![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Tumur Pathology Event concerned by the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition |
![]() ![]() ![]() ![]() | 0..1 | Reference(Tumor Pathology Event) | Value of extension | |
![]() ![]() ![]() | S | 1..1 | Identifier | Identifier of the biological sample |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The nature of the sample Binding: Biological Sample Nature Value Set (preferred) |
![]() ![]() ![]() | S | 0..1 | Reference(Oncology 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 |
![]() ![]() ![]() | S | 0..1 | Reference(Biological Sample) | Identifier of the parent biological sample |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | dateTime | Collection time Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | dateTime | Collection date |
![]() ![]() ![]() ![]() | S | 0..1 | SimpleQuantity | Percentage of tumor cells |
![]() ![]() ![]() ![]() ![]() | 0..1 | decimal | Numerical value (with implicit precision) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unit representation Required Pattern: % | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | Coded form of the unit Required Pattern: C4055283 | |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Topography of the tumor sample Binding: Topography Value Set (preferred) |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Storage method Binding: Storage temperature Value Set (extensible) |
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Storage temperature of the sample. | |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.type | preferred | BiologicalSampleNaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature from this IG | |
Specimen.collection.bodySite | preferred | Topographyhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography from this IG | |
Specimen.condition | extensible | StorageTemperaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Specimen | Sample for analysis | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin Binding: Biological Sample Origin Value Set (extensible) |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin" | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample Binding: Biological Sample Origin Value Set (extensible) |
![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Tumur Pathology Event concerned by the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition" | |
![]() ![]() ![]() ![]() | 0..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Value of extension |
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() | SΣ | 1..1 | Identifier | Identifier of the biological sample |
![]() ![]() ![]() | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | The nature of the sample Binding: Biological Sample Nature Value Set (preferred) |
![]() ![]() ![]() | SΣC | 0..1 | Reference(Oncology 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() | SC | 0..1 | Reference(Biological Sample) | Identifier of the parent biological sample ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() | 0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | dateTime | Collection date |
![]() ![]() ![]() ![]() | SC | 0..1 | SimpleQuantity | Percentage of tumor cells qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Unit representation Required Pattern: % |
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Coded form of the unit Required Pattern: C4055283 |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Topography of the tumor sample Binding: Topography Value Set (preferred) |
![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Storage method Binding: Storage temperature Value Set (extensible) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Storage temperature of the sample. |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConcept | extensible | BiologicalSampleOriginhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin from this IG | |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | preferred | BiologicalSampleNaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature from this IG | |
Specimen.collection.bodySite | preferred | Topographyhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography from this IG | |
Specimen.condition | extensible | StorageTemperaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Specimen | Sample for analysis | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin Binding: Biological Sample Origin Value Set (extensible) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..0 | |||||||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin" | |||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample Binding: Biological Sample Origin Value Set (extensible) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Origin of the sample | ||||
![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Tumur Pathology Event concerned by the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..0 | |||||||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition" | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Value of extension | ||||
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | SΣ | 1..1 | Identifier | Identifier of the biological sample | ||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | The nature of the sample Binding: Biological Sample Nature Value Set (preferred) | ||||
![]() ![]() ![]() | SΣC | 0..1 | Reference(Oncology 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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() ![]() | SC | 0..1 | Reference(Biological Sample) | Identifier of the parent biological sample ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | C | 0..* | Reference(ServiceRequest) | Why the specimen was collected ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | 0..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | dateTime | Collection date | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | Duration | How long it took to collect specimen Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration.
qty-3: If a code for the unit is present, the system SHALL also be present drt-1: 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. | ||||
![]() ![]() ![]() ![]() | SC | 0..1 | SimpleQuantity | Percentage of tumor cells qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Unit representation Required Pattern: % | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Coded form of the unit Required Pattern: C4055283 | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Topography of the tumor sample Binding: Topography Value Set (preferred) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Duration | |||||||
![]() ![]() ![]() | 0..* | BackboneElement | Processing and processing step details | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of procedure | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
![]() ![]() ![]() ![]() | C | 0..* | Reference(Substance) | Material used in the processing step ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() | 0..1 | Date and time of specimen processing | ||||||
![]() ![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Identifier | Id for the container | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of the container | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | Container volume or size qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | Quantity of specimen within container qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Reference(Substance) | |||||||
![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Storage method Binding: Storage temperature Value Set (extensible) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Storage temperature of the sample. | ||||
![]() ![]() ![]() | 0..* | Annotation | Comments | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConcept | extensible | BiologicalSampleOriginhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin from this IG | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | preferred | BiologicalSampleNaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature from this IG | ||||
Specimen.collection.duration | extensible | CommonUCUMCodesForDuration
http://hl7.org/fhir/ValueSet/duration-units from the FHIR Standard | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | preferred | Topographyhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography from this IG | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | StorageTemperaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature from this IG |
This structure is derived from Specimen
Summary
Mandatory: 4 elements (3 nested mandatory elements)
Must-Support: 10 elements
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![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Specimen | Sample for analysis | |
![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin Binding: Biological Sample Origin Value Set (extensible) |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The origin of the sample | |
![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Tumur Pathology Event concerned by the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition |
![]() ![]() ![]() ![]() | 0..1 | Reference(Tumor Pathology Event) | Value of extension | |
![]() ![]() ![]() | S | 1..1 | Identifier | Identifier of the biological sample |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The nature of the sample Binding: Biological Sample Nature Value Set (preferred) |
![]() ![]() ![]() | S | 0..1 | Reference(Oncology 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 |
![]() ![]() ![]() | S | 0..1 | Reference(Biological Sample) | Identifier of the parent biological sample |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | dateTime | Collection time Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | dateTime | Collection date |
![]() ![]() ![]() ![]() | S | 0..1 | SimpleQuantity | Percentage of tumor cells |
![]() ![]() ![]() ![]() ![]() | 0..1 | decimal | Numerical value (with implicit precision) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unit representation Required Pattern: % | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | Coded form of the unit Required Pattern: C4055283 | |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Topography of the tumor sample Binding: Topography Value Set (preferred) |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Storage method Binding: Storage temperature Value Set (extensible) |
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Storage temperature of the sample. | |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.type | preferred | BiologicalSampleNaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature from this IG | |
Specimen.collection.bodySite | preferred | Topographyhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography from this IG | |
Specimen.condition | extensible | StorageTemperaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Specimen | Sample for analysis | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin Binding: Biological Sample Origin Value Set (extensible) |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin" | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample Binding: Biological Sample Origin Value Set (extensible) |
![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Tumur Pathology Event concerned by the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition" | |
![]() ![]() ![]() ![]() | 0..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Value of extension |
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() | SΣ | 1..1 | Identifier | Identifier of the biological sample |
![]() ![]() ![]() | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | The nature of the sample Binding: Biological Sample Nature Value Set (preferred) |
![]() ![]() ![]() | SΣC | 0..1 | Reference(Oncology 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() | SC | 0..1 | Reference(Biological Sample) | Identifier of the parent biological sample ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() | 0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | dateTime | Collection date |
![]() ![]() ![]() ![]() | SC | 0..1 | SimpleQuantity | Percentage of tumor cells qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Unit representation Required Pattern: % |
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Coded form of the unit Required Pattern: C4055283 |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Topography of the tumor sample Binding: Topography Value Set (preferred) |
![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Storage method Binding: Storage temperature Value Set (extensible) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Storage temperature of the sample. |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConcept | extensible | BiologicalSampleOriginhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin from this IG | |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | preferred | BiologicalSampleNaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature from this IG | |
Specimen.collection.bodySite | preferred | Topographyhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography from this IG | |
Specimen.condition | extensible | StorageTemperaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Specimen | Sample for analysis | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin Binding: Biological Sample Origin Value Set (extensible) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..0 | |||||||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin" | |||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The origin of the sample Binding: Biological Sample Origin Value Set (extensible) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Origin of the sample | ||||
![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Tumur Pathology Event concerned by the sample URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..0 | |||||||
![]() ![]() ![]() ![]() | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition" | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | Reference(Tumor Pathology Event) | Value of extension | ||||
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | SΣ | 1..1 | Identifier | Identifier of the biological sample | ||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | The nature of the sample Binding: Biological Sample Nature Value Set (preferred) | ||||
![]() ![]() ![]() | SΣC | 0..1 | Reference(Oncology 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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() ![]() | SC | 0..1 | Reference(Biological Sample) | Identifier of the parent biological sample ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | C | 0..* | Reference(ServiceRequest) | Why the specimen was collected ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | 0..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | dateTime | Collection date | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | Duration | How long it took to collect specimen Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration.
qty-3: If a code for the unit is present, the system SHALL also be present drt-1: 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. | ||||
![]() ![]() ![]() ![]() | SC | 0..1 | SimpleQuantity | Percentage of tumor cells qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Unit representation Required Pattern: % | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Coded form of the unit Required Pattern: C4055283 | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Topography of the tumor sample Binding: Topography Value Set (preferred) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Duration | |||||||
![]() ![]() ![]() | 0..* | BackboneElement | Processing and processing step details | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of procedure | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
![]() ![]() ![]() ![]() | C | 0..* | Reference(Substance) | Material used in the processing step ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() | 0..1 | Date and time of specimen processing | ||||||
![]() ![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Identifier | Id for the container | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of the container | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | Container volume or size qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | Quantity of specimen within container qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Reference(Substance) | |||||||
![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Storage method Binding: Storage temperature Value Set (extensible) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Storage temperature of the sample. | ||||
![]() ![]() ![]() | 0..* | Annotation | Comments | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConcept | extensible | BiologicalSampleOriginhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin from this IG | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | preferred | BiologicalSampleNaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature from this IG | ||||
Specimen.collection.duration | extensible | CommonUCUMCodesForDuration
http://hl7.org/fhir/ValueSet/duration-units from the FHIR Standard | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | preferred | Topographyhttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography from this IG | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | StorageTemperaturehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature from this IG |
This structure is derived from Specimen
Summary
Mandatory: 4 elements (3 nested mandatory elements)
Must-Support: 10 elements
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