CH ELM (R4)
1.8.0-cibuild - ci-build
CH ELM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 1.8.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-elm/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-specimen | Version: 1.8.0-cibuild | |||
Active as of 2024-12-03 | Computable Name: ChElmSpecimen | |||
Copyright/Legal: CC0-1.0 |
This CH ELM base profile constrains the Specimen resource for the purpose of laboratory test reports.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ChLabSpecimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
type | 1..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' | |
coding | 0..1 | ChElmCoding | A reference to a code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: Material declared by Observation.code or non-mandatory | |
subject | 1..1 | Reference(CH ELM Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | |
collection | S | 0..1 | BackboneElement | Collection details |
Slices for collected[x] | 0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this | |
collected[x]:collectedDateTime | SC | 0..1 | dateTime | Collection time ch-elm-dateTime: At least the format YYYY-MM-DD is required. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.type.coding | required | ChElmResultsCompleteSpechttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-results-complete-spec from this IG |
Id | Grade | Path(s) | Details | Requirements |
ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | Σ | 1..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) |
coding | 0..1 | ChElmCoding | A reference to a code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Material declared by Observation.code or non-mandatory |
subject | Σ | 1..1 | Reference(CH ELM Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
collection | S | 0..1 | BackboneElement | Collection details |
Slices for extension | Content/Rules for all slices | |||
bodySite | 0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
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 |
Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
collected[x]:collectedDateTime | SΣC | 0..1 | dateTime | Collection time ch-elm-dateTime: At least the format YYYY-MM-DD is required. |
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 | |
Specimen.type.coding | required | ChElmResultsCompleteSpechttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-results-complete-spec from this IG |
Id | Grade | Path(s) | Details | Requirements |
ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10 | |
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..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |||||
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 | Σ | 1..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | 0..1 | ChElmCoding | A reference to a code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |||||
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Material declared by Observation.code or non-mandatory | ||||
subject | Σ | 1..1 | Reference(CH ELM Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(CH LAB Specimen) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected. | |||||
collection | S | 0..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
bodySite | 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 | ||||
Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
collected[x]:collectedDateTime | SΣC | 0..1 | dateTime | Collection time ch-elm-dateTime: At least the format YYYY-MM-DD is required. | ||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (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 | 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 | 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 | 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 | CommonLanguages
http://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 | ||||
Specimen.type.coding | required | ChElmResultsCompleteSpechttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-results-complete-spec 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 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Id | Grade | Path(s) | Details | Requirements |
ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10 | |
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 ChLabSpecimen
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ChLabSpecimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
type | 1..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' | |
coding | 0..1 | ChElmCoding | A reference to a code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: Material declared by Observation.code or non-mandatory | |
subject | 1..1 | Reference(CH ELM Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | |
collection | S | 0..1 | BackboneElement | Collection details |
Slices for collected[x] | 0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this | |
collected[x]:collectedDateTime | SC | 0..1 | dateTime | Collection time ch-elm-dateTime: At least the format YYYY-MM-DD is required. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.type.coding | required | ChElmResultsCompleteSpechttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-results-complete-spec from this IG |
Id | Grade | Path(s) | Details | Requirements |
ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | Σ | 1..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) |
coding | 0..1 | ChElmCoding | A reference to a code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Material declared by Observation.code or non-mandatory |
subject | Σ | 1..1 | Reference(CH ELM Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
collection | S | 0..1 | BackboneElement | Collection details |
Slices for extension | Content/Rules for all slices | |||
bodySite | 0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
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 |
Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
collected[x]:collectedDateTime | SΣC | 0..1 | dateTime | Collection time ch-elm-dateTime: At least the format YYYY-MM-DD is required. |
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 | |
Specimen.type.coding | required | ChElmResultsCompleteSpechttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-results-complete-spec from this IG |
Id | Grade | Path(s) | Details | Requirements |
ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10 | |
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..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |||||
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 | Σ | 1..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | 0..1 | ChElmCoding | A reference to a code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |||||
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Material declared by Observation.code or non-mandatory | ||||
subject | Σ | 1..1 | Reference(CH ELM Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(CH LAB Specimen) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected. | |||||
collection | S | 0..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
bodySite | 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 | ||||
Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
collected[x]:collectedDateTime | SΣC | 0..1 | dateTime | Collection time ch-elm-dateTime: At least the format YYYY-MM-DD is required. | ||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (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 | 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 | 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 | 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 | CommonLanguages
http://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 | ||||
Specimen.type.coding | required | ChElmResultsCompleteSpechttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-results-complete-spec 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 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Id | Grade | Path(s) | Details | Requirements |
ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. : $this.toString().length() >= 10 | |
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 ChLabSpecimen
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron