HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1
HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1
HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/openhie/Rwanda-HIV and changes regularly. See the Directory of published versions
| Official URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/viral-load-specimen | Version: 0.1.0 | |||
| Active as of 2023-09-15 | Computable Name: VLSpecimen | |||
Represents the VL test sample that was collected for the service request.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Specimen | 0..* | Specimen | Sample for analysis | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 SampleReordered | S | 0..1 | boolean | Sample reordered URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/sample-reordered |
  Slices for identifier | 4..* | Identifier | External Identifier Slice: Unordered, Open by value:system | |
  identifier:appSampleCode | 1..1 | Identifier | External Identifier | |
   type | ||||
 coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID | |
 display | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: App sample identifier | |
 system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/app-sample-code | |
 value | 1..1 | string | The value that is unique | |
| identifier:remoteSampleCode | 1..1 | Identifier | External Identifier | |
| type | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Remote sample identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/remote-sample-code | |
| value | 1..1 | string | The value that is unique | |
| identifier:sampleCode | 1..1 | Identifier | External Identifier | |
| type | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Sample identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/sample-code | |
| value | 1..1 | string | The value that is unique | |
 identifier:uniqueId | 1..1 | Identifier | External Identifier | |
 type | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Universal Unique Identifier for the sample | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/uniqueID | |
| value | 1..1 | string | The value that is unique | |
| type | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required) | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Specimen Type | |
| subject | 1..1 | Reference(Patient | Group | Device | BiologicallyDerivedProduct | 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, a biologically-derived product, or a device | |
| receivedTime | S | 0..1 | dateTime | The time when specimen is received by the testing laboratory |
| collection | ||||
 Slices for collected[x] | 0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this | |
 collected[x]:collectedDateTime | S | 0..1 | dateTime | Collection time |
| processing | S | 0..1 | BackboneElement | Processing and processing step details |
| Slices for time[x] | 1..1 | dateTime | Date and time of specimen processing Slice: Unordered, Open by type:$this | |
| time[x]:timeDateTime | 1..1 | dateTime | Date and time of specimen processing | |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.type | required | VSSpecimenType |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SampleReordered | S | 0..1 | boolean | Sample reordered URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/sample-reordered |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 4..* | Identifier | External Identifier Slice: Unordered, Open by value:system |
| identifier:appSampleCode | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/app-sample-code |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:remoteSampleCode | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/remote-sample-code |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:sampleCode | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/sample-code |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:uniqueId | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/uniqueID |
| 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 | Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Specimen Type |
 subject | Σ | 1..1 | Reference(Patient | Group | Device | BiologicallyDerivedProduct | 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, a biologically-derived product, or a device |
| receivedTime | SΣ | 0..1 | dateTime | The time when specimen is received by the testing laboratory |
| collection | 0..1 | BackboneElement | Collection details | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
 collectedDateTime | dateTime | |||
| collectedPeriod | Period | |||
| collected[x]:collectedDateTime | SΣ | 0..1 | dateTime | Collection time |
| processing | S | 0..1 | BackboneElement | Processing and processing step details |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for time[x] | 1..1 | dateTime | Date and time of specimen processing Slice: Unordered, Closed by type:$this | |
| time[x]:timeDateTime | 1..1 | dateTime | Date and time of specimen processing | |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.identifier:appSampleCode.use | required | IdentifierUse |
| Specimen.identifier:remoteSampleCode.use | required | IdentifierUse |
| Specimen.identifier:sampleCode.use | required | IdentifierUse |
| Specimen.identifier:uniqueId.use | required | IdentifierUse |
| Specimen.status | required | SpecimenStatus |
| Specimen.type | required | VSSpecimenType |
| 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().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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SampleReordered | S | 0..1 | boolean | Sample reordered URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/sample-reordered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 4..* | Identifier | External Identifier Slice: Unordered, Open by value:system |
| identifier:appSampleCode | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: App sample identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/app-sample-code |
| 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) |
| identifier:remoteSampleCode | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Remote sample identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/remote-sample-code |
| 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) |
| identifier:sampleCode | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Sample identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/sample-code |
| 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) |
| identifier:uniqueId | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Universal Unique Identifier for the sample |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/uniqueID |
| 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 | Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required) |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Specimen Type |
| subject | Σ | 1..1 | Reference(Patient | Group | Device | BiologicallyDerivedProduct | 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, a biologically-derived product, or a device |
| receivedTime | SΣ | 0..1 | dateTime | The time when specimen is received by the testing laboratory |
| parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |
| request | 0..* | Reference(ServiceRequest) | 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 | 0..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 |
| Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
| collectedDateTime | dateTime | |||
| collectedPeriod | Period | |||
| collected[x]:collectedDateTime | SΣ | 0..1 | dateTime | Collection time |
| duration | Σ | 0..1 | Duration | How long it took to collect specimen |
| quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
| method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
| device | 0..1 | CodeableReference(Device) | Device used to perform collection Binding: (unbound) (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 | S | 0..1 | 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 | |
| Slices for time[x] | 1..1 | dateTime | Date and time of specimen processing Slice: Unordered, Closed by type:$this | |
| time[x]:timeDateTime | 1..1 | dateTime | Date and time of specimen processing | |
| 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 | 0..1 | SimpleQuantity | Quantity of specimen within container | |
| condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.language | required | AllLanguages |
| Specimen.identifier:appSampleCode.use | required | IdentifierUse |
| Specimen.identifier:appSampleCode.type | extensible | IdentifierTypeCodes |
| Specimen.identifier:remoteSampleCode.use | required | IdentifierUse |
| Specimen.identifier:remoteSampleCode.type | extensible | IdentifierTypeCodes |
| Specimen.identifier:sampleCode.use | required | IdentifierUse |
| Specimen.identifier:sampleCode.type | extensible | IdentifierTypeCodes |
| Specimen.identifier:uniqueId.use | required | IdentifierUse |
| Specimen.identifier:uniqueId.type | extensible | IdentifierTypeCodes |
| Specimen.status | required | SpecimenStatus |
| Specimen.type | required | VSSpecimenType |
| Specimen.combined | required | SpecimenCombined |
| Specimen.role | preferred | SpecimenRole |
| Specimen.feature.type | example | SNOMEDCTBodyStructures |
| Specimen.collection.method | example | FHIRSpecimenCollectionMethod |
| Specimen.collection.device | example | |
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation |
| Specimen.processing.method | example | SpecimenProcessingMethod |
| Specimen.condition | extensible | Hl7VSSpecimenCondition |
| 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().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
Summary
Mandatory: 14 elements (2 nested mandatory elements)
Must-Support: 5 elements
Fixed Value: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen | 0..* | Specimen | Sample for analysis | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SampleReordered | S | 0..1 | boolean | Sample reordered URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/sample-reordered |
| Slices for identifier | 4..* | Identifier | External Identifier Slice: Unordered, Open by value:system | |
| identifier:appSampleCode | 1..1 | Identifier | External Identifier | |
| type | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: App sample identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/app-sample-code | |
| value | 1..1 | string | The value that is unique | |
| identifier:remoteSampleCode | 1..1 | Identifier | External Identifier | |
| type | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Remote sample identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/remote-sample-code | |
| value | 1..1 | string | The value that is unique | |
| identifier:sampleCode | 1..1 | Identifier | External Identifier | |
| type | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Sample identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/sample-code | |
| value | 1..1 | string | The value that is unique | |
| identifier:uniqueId | 1..1 | Identifier | External Identifier | |
| type | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Universal Unique Identifier for the sample | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/uniqueID | |
| value | 1..1 | string | The value that is unique | |
| type | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required) | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Specimen Type | |
| subject | 1..1 | Reference(Patient | Group | Device | BiologicallyDerivedProduct | 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, a biologically-derived product, or a device | |
| receivedTime | S | 0..1 | dateTime | The time when specimen is received by the testing laboratory |
| collection | ||||
| Slices for collected[x] | 0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this | |
| collected[x]:collectedDateTime | S | 0..1 | dateTime | Collection time |
| processing | S | 0..1 | BackboneElement | Processing and processing step details |
| Slices for time[x] | 1..1 | dateTime | Date and time of specimen processing Slice: Unordered, Open by type:$this | |
| time[x]:timeDateTime | 1..1 | dateTime | Date and time of specimen processing | |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.type | required | VSSpecimenType |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SampleReordered | S | 0..1 | boolean | Sample reordered URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/sample-reordered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 4..* | Identifier | External Identifier Slice: Unordered, Open by value:system |
| identifier:appSampleCode | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/app-sample-code |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:remoteSampleCode | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/remote-sample-code |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:sampleCode | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/sample-code |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:uniqueId | Σ | 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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/uniqueID |
| 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 | Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Specimen Type |
| subject | Σ | 1..1 | Reference(Patient | Group | Device | BiologicallyDerivedProduct | 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, a biologically-derived product, or a device |
| receivedTime | SΣ | 0..1 | dateTime | The time when specimen is received by the testing laboratory |
| collection | 0..1 | BackboneElement | Collection details | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
| collectedDateTime | dateTime | |||
| collectedPeriod | Period | |||
| collected[x]:collectedDateTime | SΣ | 0..1 | dateTime | Collection time |
| processing | S | 0..1 | BackboneElement | Processing and processing step details |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for time[x] | 1..1 | dateTime | Date and time of specimen processing Slice: Unordered, Closed by type:$this | |
| time[x]:timeDateTime | 1..1 | dateTime | Date and time of specimen processing | |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.identifier:appSampleCode.use | required | IdentifierUse |
| Specimen.identifier:remoteSampleCode.use | required | IdentifierUse |
| Specimen.identifier:sampleCode.use | required | IdentifierUse |
| Specimen.identifier:uniqueId.use | required | IdentifierUse |
| Specimen.status | required | SpecimenStatus |
| Specimen.type | required | VSSpecimenType |
| 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().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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SampleReordered | S | 0..1 | boolean | Sample reordered URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/sample-reordered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 4..* | Identifier | External Identifier Slice: Unordered, Open by value:system |
| identifier:appSampleCode | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: App sample identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/app-sample-code |
| 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) |
| identifier:remoteSampleCode | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Remote sample identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/remote-sample-code |
| 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) |
| identifier:sampleCode | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: USID |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Unique Specimen ID |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Sample identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/sample-code |
| 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) |
| identifier:uniqueId | Σ | 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. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC |
| display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Universal Unique Identifier for the sample |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/uniqueID |
| 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 | Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required) |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Specimen Type |
| subject | Σ | 1..1 | Reference(Patient | Group | Device | BiologicallyDerivedProduct | 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, a biologically-derived product, or a device |
| receivedTime | SΣ | 0..1 | dateTime | The time when specimen is received by the testing laboratory |
| parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |
| request | 0..* | Reference(ServiceRequest) | 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 | 0..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 |
| Slices for collected[x] | Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
| collectedDateTime | dateTime | |||
| collectedPeriod | Period | |||
| collected[x]:collectedDateTime | SΣ | 0..1 | dateTime | Collection time |
| duration | Σ | 0..1 | Duration | How long it took to collect specimen |
| quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
| method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
| device | 0..1 | CodeableReference(Device) | Device used to perform collection Binding: (unbound) (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 | S | 0..1 | 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 | |
| Slices for time[x] | 1..1 | dateTime | Date and time of specimen processing Slice: Unordered, Closed by type:$this | |
| time[x]:timeDateTime | 1..1 | dateTime | Date and time of specimen processing | |
| 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 | 0..1 | SimpleQuantity | Quantity of specimen within container | |
| condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.language | required | AllLanguages |
| Specimen.identifier:appSampleCode.use | required | IdentifierUse |
| Specimen.identifier:appSampleCode.type | extensible | IdentifierTypeCodes |
| Specimen.identifier:remoteSampleCode.use | required | IdentifierUse |
| Specimen.identifier:remoteSampleCode.type | extensible | IdentifierTypeCodes |
| Specimen.identifier:sampleCode.use | required | IdentifierUse |
| Specimen.identifier:sampleCode.type | extensible | IdentifierTypeCodes |
| Specimen.identifier:uniqueId.use | required | IdentifierUse |
| Specimen.identifier:uniqueId.type | extensible | IdentifierTypeCodes |
| Specimen.status | required | SpecimenStatus |
| Specimen.type | required | VSSpecimenType |
| Specimen.combined | required | SpecimenCombined |
| Specimen.role | preferred | SpecimenRole |
| Specimen.feature.type | example | SNOMEDCTBodyStructures |
| Specimen.collection.method | example | FHIRSpecimenCollectionMethod |
| Specimen.collection.device | example | |
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation |
| Specimen.processing.method | example | SpecimenProcessingMethod |
| Specimen.condition | extensible | Hl7VSSpecimenCondition |
| 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().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
Summary
Mandatory: 14 elements (2 nested mandatory elements)
Must-Support: 5 elements
Fixed Value: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Jembi Health Systems. Package openhie.fhir.rwanda.hiv#0.1.0 based on FHIR 5.0.0. Generated 2023-09-15
Links: Table of Contents |
QA Report |
Version History |
|