Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Specimen | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_Specimen_R4 | ||
This cross-version profile allows R5 Specimen content to be represented via FHIR R4 Specimen resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Specimen(4.0.1) | Sample for analysis | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR4 (0.1.0) (required): Codes for the combined status of a specimen. Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR4 (0.1.0) (preferred): Codes describing specimen role. Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Specimen.implicitRules, Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension, Specimen.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen(4.0.1) | Sample for analysis | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR4 (0.1.0) (required): Codes for the combined status of a specimen. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR4 (0.1.0) (preferred): Codes describing specimen role. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | External Identifier | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Hl7VSSpecimenType (3.0.0) (example): The type of the specimen. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | 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 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: 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, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() |
0..* | Reference(Specimen) | 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 Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Device used to perform collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.device Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.Procedure for use in FHIR R4(0.1.0) | Procedure) | R5: The procedure that collects the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.procedure Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: collector URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..1 | Collection time | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | 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. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4(0.1.0) | BodyStructure) | R5: bodySite additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: Hl7VSRelevantClincialInformation (3.0.0) (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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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) | 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 | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device) | R5: Device resource for the container (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) | R5: Where the container is (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Id for the container | ||||
![]() ![]() ![]() |
0..1 | string | Textual description of the container | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||
![]() ![]() ![]() |
0..1 | Additive associated with container Binding: Hl7VSAdditivePreservative (3.0.0) (example): Substance added to specimen container. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen. | ||||
![]() ![]() |
0..* | Annotation | Comments | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| Specimen.subject.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Specimen.collection.collector.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📍3.0.0 | THO v7.1 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.1 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📍3.0.0 | THO v7.1 |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Specimen.meta, Specimen.implicitRules, Specimen.language, Specimen.text, Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.subject.extension, Specimen.subject.extension:subject, Specimen.subject.reference, Specimen.subject.type, Specimen.subject.identifier, Specimen.subject.display, Specimen.receivedTime, Specimen.parent, Specimen.request, Specimen.collection, Specimen.collection.extension, Specimen.collection.extension:device, Specimen.collection.extension:procedure, Specimen.collection.modifierExtension, Specimen.collection.collector, Specimen.collection.collector.extension, Specimen.collection.collector.extension:collector, Specimen.collection.collector.reference, Specimen.collection.collector.type, Specimen.collection.collector.identifier, Specimen.collection.collector.display, Specimen.collection.collected[x], Specimen.collection.duration, Specimen.collection.quantity, Specimen.collection.method, Specimen.collection.bodySite, Specimen.collection.bodySite.extension, Specimen.collection.bodySite.extension:bodySite, Specimen.collection.bodySite.coding, Specimen.collection.bodySite.text, Specimen.collection.fastingStatus[x], Specimen.processing, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.processing.description, Specimen.processing.procedure, Specimen.processing.additive, Specimen.processing.time[x], Specimen.container, Specimen.container.extension, Specimen.container.extension:device, Specimen.container.extension:location, Specimen.container.modifierExtension, Specimen.container.identifier, Specimen.container.description, Specimen.container.type, Specimen.container.capacity, Specimen.container.specimenQuantity, Specimen.container.additive[x], Specimen.condition, Specimen.note | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension, Specimen.subject.extension, Specimen.subject.extension:subject, Specimen.collection.extension, Specimen.collection.extension:device, Specimen.collection.extension:procedure, Specimen.collection.modifierExtension, Specimen.collection.collector.extension, Specimen.collection.collector.extension:collector, Specimen.collection.bodySite.extension, Specimen.collection.bodySite.extension:bodySite, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.container.extension, Specimen.container.extension:device, Specimen.container.extension:location, Specimen.container.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Specimen
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Specimen(4.0.1) | Sample for analysis | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR4 (0.1.0) (required): Codes for the combined status of a specimen. Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR4 (0.1.0) (preferred): Codes describing specimen role. Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Specimen.implicitRules, Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension, Specimen.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Specimen
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen(4.0.1) | Sample for analysis | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | code | R5: grouped | pooled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.combined Binding: R5SpecimenCombinedForR4 (0.1.0) (required): Codes for the combined status of a specimen. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | R5: The role the specimen serves (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.role Binding: R5SpecimenRoleForR4 (0.1.0) (preferred): Codes describing specimen role. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: The physical feature of a specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.feature Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | External Identifier | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Hl7VSSpecimenType (3.0.0) (example): The type of the specimen. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | 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 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: 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, a biologically-derived product, or a device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() |
0..* | Reference(Specimen) | 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 Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Device used to perform collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.device Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.Procedure for use in FHIR R4(0.1.0) | Procedure) | R5: The procedure that collects the specimen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.procedure Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: collector URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..1 | Collection time | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | 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. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4(0.1.0) | BodyStructure) | R5: bodySite additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: Hl7VSRelevantClincialInformation (3.0.0) (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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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) | 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 | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device) | R5: Device resource for the container (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) | R5: Where the container is (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Id for the container | ||||
![]() ![]() ![]() |
0..1 | string | Textual description of the container | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||
![]() ![]() ![]() |
0..1 | Additive associated with container Binding: Hl7VSAdditivePreservative (3.0.0) (example): Substance added to specimen container. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen. | ||||
![]() ![]() |
0..* | Annotation | Comments | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| Specimen.subject.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Specimen.collection.collector.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📍3.0.0 | THO v7.1 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.1 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📍3.0.0 | THO v7.1 |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Specimen.meta, Specimen.implicitRules, Specimen.language, Specimen.text, Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.subject.extension, Specimen.subject.extension:subject, Specimen.subject.reference, Specimen.subject.type, Specimen.subject.identifier, Specimen.subject.display, Specimen.receivedTime, Specimen.parent, Specimen.request, Specimen.collection, Specimen.collection.extension, Specimen.collection.extension:device, Specimen.collection.extension:procedure, Specimen.collection.modifierExtension, Specimen.collection.collector, Specimen.collection.collector.extension, Specimen.collection.collector.extension:collector, Specimen.collection.collector.reference, Specimen.collection.collector.type, Specimen.collection.collector.identifier, Specimen.collection.collector.display, Specimen.collection.collected[x], Specimen.collection.duration, Specimen.collection.quantity, Specimen.collection.method, Specimen.collection.bodySite, Specimen.collection.bodySite.extension, Specimen.collection.bodySite.extension:bodySite, Specimen.collection.bodySite.coding, Specimen.collection.bodySite.text, Specimen.collection.fastingStatus[x], Specimen.processing, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.processing.description, Specimen.processing.procedure, Specimen.processing.additive, Specimen.processing.time[x], Specimen.container, Specimen.container.extension, Specimen.container.extension:device, Specimen.container.extension:location, Specimen.container.modifierExtension, Specimen.container.identifier, Specimen.container.description, Specimen.container.type, Specimen.container.capacity, Specimen.container.specimenQuantity, Specimen.container.additive[x], Specimen.condition, Specimen.note | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.extension:combined, Specimen.extension:role, Specimen.extension:feature, Specimen.modifierExtension, Specimen.subject.extension, Specimen.subject.extension:subject, Specimen.collection.extension, Specimen.collection.extension:device, Specimen.collection.extension:procedure, Specimen.collection.modifierExtension, Specimen.collection.collector.extension, Specimen.collection.collector.extension:collector, Specimen.collection.bodySite.extension, Specimen.collection.bodySite.extension:bodySite, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.container.extension, Specimen.container.extension:device, Specimen.container.extension:location, Specimen.container.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Specimen
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron