Botswana FHIR Implementation Guide
1.0.0 - ci-build
Botswana FHIR Implementation Guide
1.0.0 - ci-build
Botswana FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/botswana-hie-fhir-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://moh.bw.org/StructureDefinition/lab-order-specimen | Version: 1.0.0 | |||
| Active as of 2026-10-13 | Computable Name: LabOrderSpecimen | |||
The specimen associated with the lab order.
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:  |
|---|---|---|---|---|
  Specimen |
0..* | Specimen | Sample for analysis | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  Slices for identifier |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   identifier:USID |
1..1 | Identifier | External Identifier | |
  use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |
 value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
 type |
0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |
 subject |
1..1 | Reference(Patient - Botswana 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, a biologically-derived product, or a device | |
| receivedTime |
0..1 | dateTime | The time when specimen is received by the testing laboratory | |
| request |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |
 collection |
1..1 | BackboneElement | Collection details | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 collected[x] |
1..1 | dateTime | Collection time | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.identifier:USID.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std. |
| Specimen.type | Base | example | hl7VS-specimenType | 📦3.0.0 | THO v7.4 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 Specimen
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| Slices for identifier |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:USID |
1..1 | Identifier | External Identifier | |
 system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |
| value |
1..1 | string | The value that is unique | |
| type |
0..1 | CodeableConcept | Kind of material that forms the specimen | |
| subject |
1..1 | Reference(Patient - Botswana 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, a biologically-derived product, or a device | |
| receivedTime |
0..1 | dateTime | The time when specimen is received by the testing laboratory | |
| request |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |
| collection |
1..1 | BackboneElement | Collection details | |
| collected[x] |
1..1 | dateTime | Collection time | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:USID |
1..1 | Identifier | External Identifier | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| 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 |
0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |||||
| subject |
1..1 | Reference(Patient - Botswana 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, a biologically-derived product, or a device | |||||
| receivedTime |
0..1 | dateTime | The time when specimen is received by the testing laboratory | |||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
| request |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |||||
| combined |
0..1 | code | grouped | pooled Binding: SpecimenCombined (required): Codes for the combined status of a specimen. | |||||
| role |
0..* | CodeableConcept | The role the specimen serves Binding: SpecimenRole (preferred): Codes describing specimen role. | |||||
| feature |
0..* | BackboneElement | The physical feature of a specimen | |||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Highlighted feature Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| description |
1..1 | string | Information about the feature | |||||
| collection |
1..1 | BackboneElement | Collection 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 | |||||
| collector |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who collected the specimen | |||||
| collected[x] |
1..1 | dateTime | Collection time | |||||
| duration |
0..1 | Duration | How long it took to collect specimen | |||||
| quantity |
C | 0..1 | SimpleQuantity(5.0.0) | The quantity of specimen collected Constraints: sqty-1 | ||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| device |
0..1 | CodeableReference(Device) | Device used to perform collection Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line). | |||||
| procedure |
0..1 | Reference(Procedure) | The procedure that collects the specimen | |||||
| bodySite |
0..1 | CodeableReference(BodyStructure) | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
 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 | |||||
| method |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingMethod (example): Type indicating the technique used to process the specimen. | |||||
| additive |
0..* | Reference(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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| device |
1..1 | Reference(Device) | Device resource for the container | |||||
| location |
0..1 | Reference(Location) | Where the container is | |||||
| specimenQuantity |
C | 0..1 | SimpleQuantity(5.0.0) | Quantity of specimen within container Constraints: sqty-1 | ||||
| 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 | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Specimen.identifier:USID.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Specimen.identifier:USID.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std. |
| Specimen.type | Base | example | hl7VS-specimenType | 📦3.0.0 | THO v7.4 |
| Specimen.combined | Base | required | Specimen Combined | 📍5.0.0 | FHIR Std. |
| Specimen.role | Base | preferred | Specimen Role | 📍5.0.0 | FHIR Std. |
| Specimen.feature.type | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍5.0.0 | FHIR Std. |
| Specimen.collection.device | Base | example | Not State | Unknown | |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦3.0.0 | THO v7.4 |
| Specimen.processing.method | Base | example | Specimen Processing Method | 📍5.0.0 | FHIR Std. |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦3.0.0 | THO v7.4 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Specimen
Summary
Mandatory: 8 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:USID |
1..1 | Identifier | External Identifier | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |
| value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
| type |
0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |
| subject |
1..1 | Reference(Patient - Botswana 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, a biologically-derived product, or a device | |
| receivedTime |
0..1 | dateTime | The time when specimen is received by the testing laboratory | |
| request |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |
| collection |
1..1 | BackboneElement | Collection details | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| collected[x] |
1..1 | dateTime | Collection time | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.identifier:USID.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std. |
| Specimen.type | Base | example | hl7VS-specimenType | 📦3.0.0 | THO v7.4 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
Differential View
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| Slices for identifier |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:USID |
1..1 | Identifier | External Identifier | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |
| value |
1..1 | string | The value that is unique | |
| type |
0..1 | CodeableConcept | Kind of material that forms the specimen | |
| subject |
1..1 | Reference(Patient - Botswana 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, a biologically-derived product, or a device | |
| receivedTime |
0..1 | dateTime | The time when specimen is received by the testing laboratory | |
| request |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |
| collection |
1..1 | BackboneElement | Collection details | |
| collected[x] |
1..1 | dateTime | Collection time | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:USID |
1..1 | Identifier | External Identifier | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| 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 |
0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | |||||
| subject |
1..1 | Reference(Patient - Botswana 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, a biologically-derived product, or a device | |||||
| receivedTime |
0..1 | dateTime | The time when specimen is received by the testing laboratory | |||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
| request |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |||||
| combined |
0..1 | code | grouped | pooled Binding: SpecimenCombined (required): Codes for the combined status of a specimen. | |||||
| role |
0..* | CodeableConcept | The role the specimen serves Binding: SpecimenRole (preferred): Codes describing specimen role. | |||||
| feature |
0..* | BackboneElement | The physical feature of a specimen | |||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Highlighted feature Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| description |
1..1 | string | Information about the feature | |||||
| collection |
1..1 | BackboneElement | Collection 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 | |||||
| collector |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who collected the specimen | |||||
| collected[x] |
1..1 | dateTime | Collection time | |||||
| duration |
0..1 | Duration | How long it took to collect specimen | |||||
| quantity |
C | 0..1 | SimpleQuantity(5.0.0) | The quantity of specimen collected Constraints: sqty-1 | ||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| device |
0..1 | CodeableReference(Device) | Device used to perform collection Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line). | |||||
| procedure |
0..1 | Reference(Procedure) | The procedure that collects the specimen | |||||
| bodySite |
0..1 | CodeableReference(BodyStructure) | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| 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 | |||||
| method |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingMethod (example): Type indicating the technique used to process the specimen. | |||||
| additive |
0..* | Reference(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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| device |
1..1 | Reference(Device) | Device resource for the container | |||||
| location |
0..1 | Reference(Location) | Where the container is | |||||
| specimenQuantity |
C | 0..1 | SimpleQuantity(5.0.0) | Quantity of specimen within container Constraints: sqty-1 | ||||
| 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 | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Specimen.identifier:USID.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Specimen.identifier:USID.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std. |
| Specimen.type | Base | example | hl7VS-specimenType | 📦3.0.0 | THO v7.4 |
| Specimen.combined | Base | required | Specimen Combined | 📍5.0.0 | FHIR Std. |
| Specimen.role | Base | preferred | Specimen Role | 📍5.0.0 | FHIR Std. |
| Specimen.feature.type | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍5.0.0 | FHIR Std. |
| Specimen.collection.device | Base | example | Not State | Unknown | |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦3.0.0 | THO v7.4 |
| Specimen.processing.method | Base | example | Specimen Processing Method | 📍5.0.0 | FHIR Std. |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦3.0.0 | THO v7.4 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Specimen
Summary
Mandatory: 8 elements
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