Botswana FHIR Implementation Guide
1.0.0 - STU1
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 2025-03-10 | Computable Name: LabOrderSpecimen |
The specimen associated with the lab order.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | External Identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://moh.bw.org/identifier/specimen-id |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(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 or a device ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
1..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Collection time ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: v2 Relevant Clincial Information ![]() ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9) ![]() ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) ![]() ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.identifier:USID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.collection.fastingStatus[x] | extensible | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916 | |
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916|2.9 | |
Specimen.condition | required | v2.0493 ![]() http://terminology.hl7.org/ValueSet/v2-0493|2.9 |
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 Specimen
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
Specimen | |||
![]() ![]() ![]() |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
1..1 | Identifier | External Identifier | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
![]() ![]() ![]() |
1..1 | Reference(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 or a device | |
![]() ![]() ![]() |
S | 0..1 | dateTime | The time when specimen was received for processing |
![]() ![]() ![]() |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |
![]() ![]() ![]() |
1..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() |
1..1 | dateTime | Collection time | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9) ![]() | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept, Reference(Substance) | Additive associated with container Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additive associated with container Binding: v2.0371 (2.9) ![]() | |
![]() ![]() ![]() |
0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) ![]() | |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916|2.9 | |
Specimen.container.additive[x]:additiveCodeableConcept | required | v2.0371 ![]() http://terminology.hl7.org/ValueSet/v2-0371|2.9 | |
Specimen.condition | required | v2.0493 ![]() http://terminology.hl7.org/ValueSet/v2-0493|2.9 |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Specimen | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | External Identifier | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(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 or a device | ||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() ![]() |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
![]() ![]() ![]() |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Collection 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 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Collection time | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: v2 Relevant Clincial Information ![]() | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9) ![]() | ||||
![]() ![]() ![]() |
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) | 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 | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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: SpecimenContainerType (example): Type of specimen container. | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Container volume or size | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
![]() ![]() ![]() ![]() |
0..1 | Additive associated with container Slice: Unordered, Open by type:$this Binding: v2 Additive ![]() | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additive associated with container Binding: v2.0371 (2.9) ![]() | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) ![]() | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.identifier:USID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.identifier:USID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Specimen.collection.fastingStatus[x] | extensible | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916|2.9 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | v2.0371 ![]() http://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.container.additive[x]:additiveCodeableConcept | required | v2.0371 ![]() http://terminology.hl7.org/ValueSet/v2-0371|2.9 | ||||
Specimen.condition | required | v2.0493 ![]() http://terminology.hl7.org/ValueSet/v2-0493|2.9 |
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 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | External Identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://moh.bw.org/identifier/specimen-id |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(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 or a device ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
1..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Collection time ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: v2 Relevant Clincial Information ![]() ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9) ![]() ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) ![]() ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.identifier:USID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.collection.fastingStatus[x] | extensible | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916 | |
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916|2.9 | |
Specimen.condition | required | v2.0493 ![]() http://terminology.hl7.org/ValueSet/v2-0493|2.9 |
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() |
Differential View
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
Specimen | |||
![]() ![]() ![]() |
1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
1..1 | Identifier | External Identifier | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
![]() ![]() ![]() |
1..1 | Reference(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 or a device | |
![]() ![]() ![]() |
S | 0..1 | dateTime | The time when specimen was received for processing |
![]() ![]() ![]() |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |
![]() ![]() ![]() |
1..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() |
1..1 | dateTime | Collection time | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9) ![]() | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept, Reference(Substance) | Additive associated with container Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additive associated with container Binding: v2.0371 (2.9) ![]() | |
![]() ![]() ![]() |
0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) ![]() | |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916|2.9 | |
Specimen.container.additive[x]:additiveCodeableConcept | required | v2.0371 ![]() http://terminology.hl7.org/ValueSet/v2-0371|2.9 | |
Specimen.condition | required | v2.0493 ![]() http://terminology.hl7.org/ValueSet/v2-0493|2.9 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Specimen | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | External Identifier | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/specimen-id | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(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 or a device | ||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing | ||||
![]() ![]() ![]() |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
![]() ![]() ![]() |
1..* | Reference(ServiceRequest - Lab Orders) | Why the specimen was collected | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Collection 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 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Collection time | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Slice: Unordered, Open by type:$this Binding: v2 Relevant Clincial Information ![]() | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9) ![]() | ||||
![]() ![]() ![]() |
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) | 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 | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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: SpecimenContainerType (example): Type of specimen container. | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Container volume or size | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
![]() ![]() ![]() ![]() |
0..1 | Additive associated with container Slice: Unordered, Open by type:$this Binding: v2 Additive ![]() | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additive associated with container Binding: v2.0371 (2.9) ![]() | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) ![]() | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.identifier:USID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.identifier:USID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Specimen.collection.fastingStatus[x] | extensible | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.collection.fastingStatus[x]:fastingStatusCodeableConcept | required | v2.0916 ![]() http://terminology.hl7.org/ValueSet/v2-0916|2.9 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | v2.0371 ![]() http://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.container.additive[x]:additiveCodeableConcept | required | v2.0371 ![]() http://terminology.hl7.org/ValueSet/v2-0371|2.9 | ||||
Specimen.condition | required | v2.0493 ![]() http://terminology.hl7.org/ValueSet/v2-0493|2.9 |
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 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
IG © 2021+ Jembi Health Systems. Package botswana.hie.fhir#1.0.0 based on FHIR 4.0.1. Generated 2025-03-10
Links: Table of Contents |
QA Report