North West Genomic Medicine Service Alliance
0.0.1 - ci-build
DRAFT Implementation Guide
This is for collaboration and discussion purposes and is subject to change.
North West Genomic Medicine Service Alliance - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://nw-gmsa.github.io/StructureDefinition/Specimen | Version: 0.0.1 | |||
Draft as of 2025-06-19 | Computable Name: Specimen |
Includes constraints from:
See also HL7 Europe Laboratory Report - Specimen: Laboratory
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SpecimenEu
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | SpecimenEu | Laboratory Specimen | |
![]() ![]() ![]() |
S | 1..* | CorrelationIdentifier | External Identifier |
![]() ![]() ![]() |
S | 0..1 | AccessionNumber | Identifier assigned by the lab |
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Collection time |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | The quantity of specimen collected |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.type | required | SpecimenTypehttps://nw-gmsa.github.io/ValueSet/specimen-type From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | SpecimenEu | Laboratory Specimen | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier |
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | 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. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
![]() ![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | The quantity of specimen collected |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred) |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard | |
Specimen.type | required | SpecimenTypehttps://nw-gmsa.github.io/ValueSet/specimen-type From this IG | |
Specimen.collection.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard |
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 Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | SpecimenEu | Laboratory Specimen | |||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() ![]() |
0..* | Reference(Specimen: Laboratory) | Specimen from which this specimen originated | |||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected. | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | The quantity of specimen collected | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (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 | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Substance | Substance: Specimen Additive Substance) | Material used in the processing step | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(UK Core Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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: Specimen Container (preferred) | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Container volume or size | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() |
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 | required | SpecimenTypehttps://nw-gmsa.github.io/ValueSet/specimen-type 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 |
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
Summary
Mandatory: 2 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from SpecimenEu
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | SpecimenEu | Laboratory Specimen | |
![]() ![]() ![]() |
S | 1..* | CorrelationIdentifier | External Identifier |
![]() ![]() ![]() |
S | 0..1 | AccessionNumber | Identifier assigned by the lab |
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Collection time |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | The quantity of specimen collected |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.type | required | SpecimenTypehttps://nw-gmsa.github.io/ValueSet/specimen-type From this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | SpecimenEu | Laboratory Specimen | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier |
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | 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. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
![]() ![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | The quantity of specimen collected |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred) |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard | |
Specimen.type | required | SpecimenTypehttps://nw-gmsa.github.io/ValueSet/specimen-type From this IG | |
Specimen.collection.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard |
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 Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | SpecimenEu | Laboratory Specimen | |||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() ![]() |
0..* | Reference(Specimen: Laboratory) | Specimen from which this specimen originated | |||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected. | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | The quantity of specimen collected | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (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 | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Substance | Substance: Specimen Additive Substance) | Material used in the processing step | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(UK Core Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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: Specimen Container (preferred) | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Container volume or size | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() |
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 | required | SpecimenTypehttps://nw-gmsa.github.io/ValueSet/specimen-type 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 |
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
Summary
Mandatory: 2 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron