HL7 Europe Laboratory Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/laboratory/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Specimen-obl-eu-lab | Version: 0.2.0-ci | |||
Standards status: Informative | Maturity Level: 0 | Computable Name: SpecimenEuObligations | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
This profile defines obligations for Specimen in FHIR for the purpose of this guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SpecimenEu
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Specimen | 0..* | SpecimenEu | Laboratory Specimen | |||||||||
type | O | 0..1 | CodeableConcept | Kind of material that forms the specimen
| ||||||||
subject | O | 0..1 | Reference(Patient (EU) | Patient: Animal | Group | Device | Substance | Location) | 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
| ||||||||
request | O | 0..* | Reference(ServiceRequest) | Why the specimen was collected.
| ||||||||
collection | O | 0..1 | BackboneElement | Collection details
| ||||||||
Slices for extension | Content/Rules for all slices | |||||||||||
extension:bodySite | O | 0..1 | BodyStructureReference(5.1.0) | Target anatomic location or structure
| ||||||||
bodySite | O | 0..1 | CodeableConcept | Anatomical collection site
| ||||||||
processing | ||||||||||||
additive | O | 0..* | Reference(Substance | Substance: Specimen Additive Substance) | Material used in the processing step
| ||||||||
container | O | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
| ||||||||
type | O | 0..1 | CodeableConcept | Kind of container directly associated with specimen
| ||||||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Specimen | 0..* | SpecimenEu | Laboratory Specimen dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children | ||||||||
type | OΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Types (preferred) ele-1: All FHIR elements must have a @value or children
| ||||||||
subject | OΣ | 0..1 | Reference(Patient (EU) | Patient: Animal | Group | Device | Substance | Location) | 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 ele-1: All FHIR elements must have a @value or children
| ||||||||
request | O | 0..* | Reference(ServiceRequest) | Why the specimen was collected. ele-1: All FHIR elements must have a @value or children
| ||||||||
collection | O | 0..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children
| ||||||||
Slices for extension | Content/Rules for all slices | |||||||||||
bodySite | O | 0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||
extension | 0..0 | |||||||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||||||
value[x] | 1..1 | Reference(Body structure: Laboratory) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
bodySite | O | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred) ele-1: All FHIR elements must have a @value or children
| ||||||||
container | O | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) ele-1: All FHIR elements must have a @value or children
| ||||||||
Slices for extension | Content/Rules for all slices | |||||||||||
device | 0..1 | Reference(Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
type | O | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: Specimen Container (preferred) ele-1: All FHIR elements must have a @value or children
| ||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | preferred | LabSpecimenTypesEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-lab from this IG | |
Specimen.collection.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
Specimen.container.type | preferred | LabSpecimenContainerEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab from this IG |
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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Specimen | 0..* | SpecimenEu | Laboratory Specimen | |||||||||
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 | |||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
identifier | Σ | 0..* | Identifier | External Identifier | ||||||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
type | OΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Types (preferred)
| ||||||||
subject | OΣ | 0..1 | Reference(Patient (EU) | Patient: Animal | Group | Device | Substance | Location) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
| ||||||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||
parent | 0..* | Reference(Specimen: Laboratory) | Specimen from which this specimen originated | |||||||||
request | O | 0..* | Reference(ServiceRequest) | Why the specimen was collected.
| ||||||||
collection | O | 0..1 | BackboneElement | Collection details
| ||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
bodySite | O | 0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite
| ||||||||
id | 0..1 | id | Unique id for inter-element referencing | |||||||||
extension | 0..0 | |||||||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||||||
value[x] | 1..1 | Reference(Body structure: Laboratory) | Value of extension | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||||||
collected[x] | Σ | 0..1 | Collection time | |||||||||
collectedDateTime | dateTime | |||||||||||
collectedPeriod | Period | |||||||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||||||
bodySite | O | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred)
| ||||||||
fastingStatus[x] | Σ | 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. | |||||||||
fastingStatusCodeableConcept | CodeableConcept | |||||||||||
fastingStatusDuration | Duration | |||||||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
description | 0..1 | string | Textual description of procedure | |||||||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||||||
additive | O | 0..* | Reference(Substance | Substance: Specimen Additive Substance) | Material used in the processing step
| ||||||||
time[x] | 0..1 | Date and time of specimen processing | ||||||||||
timeDateTime | dateTime | |||||||||||
timePeriod | Period | |||||||||||
container | O | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
| ||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
device | 0..1 | Reference(Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||||||
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 | O | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: Specimen Container (preferred)
| ||||||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||||||
note | 0..* | Annotation | Comments | |||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | preferred | LabSpecimenTypesEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-lab from this IG | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
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 | preferred | LabSpecimenContainerEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab from this IG | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from SpecimenEu
Differential View
This structure is derived from SpecimenEu
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Specimen | 0..* | SpecimenEu | Laboratory Specimen | |||||||||
type | O | 0..1 | CodeableConcept | Kind of material that forms the specimen
| ||||||||
subject | O | 0..1 | Reference(Patient (EU) | Patient: Animal | Group | Device | Substance | Location) | 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
| ||||||||
request | O | 0..* | Reference(ServiceRequest) | Why the specimen was collected.
| ||||||||
collection | O | 0..1 | BackboneElement | Collection details
| ||||||||
Slices for extension | Content/Rules for all slices | |||||||||||
extension:bodySite | O | 0..1 | BodyStructureReference(5.1.0) | Target anatomic location or structure
| ||||||||
bodySite | O | 0..1 | CodeableConcept | Anatomical collection site
| ||||||||
processing | ||||||||||||
additive | O | 0..* | Reference(Substance | Substance: Specimen Additive Substance) | Material used in the processing step
| ||||||||
container | O | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
| ||||||||
type | O | 0..1 | CodeableConcept | Kind of container directly associated with specimen
| ||||||||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Specimen | 0..* | SpecimenEu | Laboratory Specimen dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children | ||||||||
type | OΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Types (preferred) ele-1: All FHIR elements must have a @value or children
| ||||||||
subject | OΣ | 0..1 | Reference(Patient (EU) | Patient: Animal | Group | Device | Substance | Location) | 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 ele-1: All FHIR elements must have a @value or children
| ||||||||
request | O | 0..* | Reference(ServiceRequest) | Why the specimen was collected. ele-1: All FHIR elements must have a @value or children
| ||||||||
collection | O | 0..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children
| ||||||||
Slices for extension | Content/Rules for all slices | |||||||||||
bodySite | O | 0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||
extension | 0..0 | |||||||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||||||
value[x] | 1..1 | Reference(Body structure: Laboratory) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
bodySite | O | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred) ele-1: All FHIR elements must have a @value or children
| ||||||||
container | O | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) ele-1: All FHIR elements must have a @value or children
| ||||||||
Slices for extension | Content/Rules for all slices | |||||||||||
device | 0..1 | Reference(Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
type | O | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: Specimen Container (preferred) ele-1: All FHIR elements must have a @value or children
| ||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | preferred | LabSpecimenTypesEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-lab from this IG | |
Specimen.collection.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
Specimen.container.type | preferred | LabSpecimenContainerEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab from this IG |
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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Specimen | 0..* | SpecimenEu | Laboratory Specimen | |||||||||
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 | |||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
identifier | Σ | 0..* | Identifier | External Identifier | ||||||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
type | OΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Types (preferred)
| ||||||||
subject | OΣ | 0..1 | Reference(Patient (EU) | Patient: Animal | Group | Device | Substance | Location) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
| ||||||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||
parent | 0..* | Reference(Specimen: Laboratory) | Specimen from which this specimen originated | |||||||||
request | O | 0..* | Reference(ServiceRequest) | Why the specimen was collected.
| ||||||||
collection | O | 0..1 | BackboneElement | Collection details
| ||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
bodySite | O | 0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite
| ||||||||
id | 0..1 | id | Unique id for inter-element referencing | |||||||||
extension | 0..0 | |||||||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||||||
value[x] | 1..1 | Reference(Body structure: Laboratory) | Value of extension | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||||||
collected[x] | Σ | 0..1 | Collection time | |||||||||
collectedDateTime | dateTime | |||||||||||
collectedPeriod | Period | |||||||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||||||
bodySite | O | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred)
| ||||||||
fastingStatus[x] | Σ | 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. | |||||||||
fastingStatusCodeableConcept | CodeableConcept | |||||||||||
fastingStatusDuration | Duration | |||||||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
description | 0..1 | string | Textual description of procedure | |||||||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||||||
additive | O | 0..* | Reference(Substance | Substance: Specimen Additive Substance) | Material used in the processing step
| ||||||||
time[x] | 0..1 | Date and time of specimen processing | ||||||||||
timeDateTime | dateTime | |||||||||||
timePeriod | Period | |||||||||||
container | O | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
| ||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
device | 0..1 | Reference(Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||||||
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 | O | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: Specimen Container (preferred)
| ||||||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||||||
note | 0..* | Annotation | Comments | |||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | preferred | LabSpecimenTypesEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-lab from this IG | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
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 | preferred | LabSpecimenContainerEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab from this IG | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from SpecimenEu
Other representations of profile: CSV, Excel, Schematron