Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-organism-isolate-specimen | Version: 3.0.0-ballot | ||||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: EICROrganismIsolateSpecimen | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.91 | |||||
This Specimen profile represents a microbial isolate derived from a clinical specimen (for example, an organism isolated from a urine culture). It is referenced as the specimen of each eICR Organism Susceptibility Observation so that a susceptibility result is self-contained: the isolate identifies what was tested and its parent identifies the clinical specimen (source, body site, and collection details) from which the organism was isolated. This follows the FHIR Diagnostics module pattern of linking a derived specimen to its source specimen through Specimen.parent.
This profile is based on and further constrains the US Public Health Specimen profile.
It represents a microbial isolate derived from a clinical specimen, following the FHIR Diagnostics module (Microbiology) pattern in which a Specimen Isolate references the Specimen it was isolated from using Specimen.parent.
See the Klebsiella oxytoca Isolate and Urine Specimen examples.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | USPublicHealthSpecimen | eICR Organism Isolate Specimen | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | Identifier | (USCDI+) Specimen Identifier | |
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
![]() ![]() |
1..1 | CodeableConcept | Microbial isolate specimen Binding: SpecimenType (20240606) (extensible)Required Pattern: | |
![]() ![]() |
1..1 | Reference(US Public Health Patient | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |
![]() ![]() |
1..1 | Reference(US Public Health Specimen Profile) | Clinical specimen the organism was isolated from | |
![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | (USCDI+) Specimen Collection Date/Time | ||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI+) Specimen Source Site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | extensible |
Specimen type
|
📍20240606 | VSAC v0.23 |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **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 USPublicHealthSpecimen
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | USPublicHealthSpecimen | eICR Organism Isolate Specimen | |
![]() ![]() |
1..1 | CodeableConcept | Microbial isolate specimen Required Pattern: | |
![]() ![]() |
1..1 | Reference(US Public Health Patient | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |
![]() ![]() |
1..1 | Reference(US Public Health Specimen Profile) | Clinical specimen the organism was isolated from | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USPublicHealthSpecimen | eICR Organism Isolate Specimen | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External Identifier | |||||
![]() ![]() |
0..1 | Identifier | (USCDI+) Specimen Identifier | |||||
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
![]() ![]() |
1..1 | CodeableConcept | Microbial isolate specimen Binding: SpecimenType (20240606) (extensible)Required Pattern: | |||||
![]() ![]() |
1..1 | Reference(US Public Health Patient | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |||||
![]() ![]() |
0..1 | dateTime | The time when specimen was received for processing | |||||
![]() ![]() |
1..1 | Reference(US Public Health Specimen Profile) | Clinical specimen the organism was isolated from | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
![]() ![]() |
0..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 | |||||
![]() ![]() ![]() |
0..1 | (USCDI+) Specimen Collection Date/Time | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Duration | How long it took to collect specimen | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | The quantity of specimen collected Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI+) Specimen Source Site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() |
0..1 | Whether or how long patient abstained from food and/or drink Binding: Hl7VSRelevantClincialInformation (3.0.0) (extensible): Codes describing the fasting status of the patient. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Container volume or size Constraints: sqty-1 | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Quantity of specimen within container Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | Additive associated with container Binding: Hl7VSAdditivePreservative (3.0.0) (example): Substance added to specimen container. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() |
0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen. | |||||
![]() ![]() |
0..* | Annotation | Comments | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | extensible |
Specimen type
|
📍20240606 | VSAC v0.23 |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📍3.0.0 | THO v7.5 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📦4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📦4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.5 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📍3.0.0 | THO v7.5 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from USPublicHealthSpecimen
Summary
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | USPublicHealthSpecimen | eICR Organism Isolate Specimen | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | Identifier | (USCDI+) Specimen Identifier | |
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
![]() ![]() |
1..1 | CodeableConcept | Microbial isolate specimen Binding: SpecimenType (20240606) (extensible)Required Pattern: | |
![]() ![]() |
1..1 | Reference(US Public Health Patient | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |
![]() ![]() |
1..1 | Reference(US Public Health Specimen Profile) | Clinical specimen the organism was isolated from | |
![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | (USCDI+) Specimen Collection Date/Time | ||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI+) Specimen Source Site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | extensible |
Specimen type
|
📍20240606 | VSAC v0.23 |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **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 USPublicHealthSpecimen
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | USPublicHealthSpecimen | eICR Organism Isolate Specimen | |
![]() ![]() |
1..1 | CodeableConcept | Microbial isolate specimen Required Pattern: | |
![]() ![]() |
1..1 | Reference(US Public Health Patient | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |
![]() ![]() |
1..1 | Reference(US Public Health Specimen Profile) | Clinical specimen the organism was isolated from | |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USPublicHealthSpecimen | eICR Organism Isolate Specimen | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External Identifier | |||||
![]() ![]() |
0..1 | Identifier | (USCDI+) Specimen Identifier | |||||
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
![]() ![]() |
1..1 | CodeableConcept | Microbial isolate specimen Binding: SpecimenType (20240606) (extensible)Required Pattern: | |||||
![]() ![]() |
1..1 | Reference(US Public Health Patient | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |||||
![]() ![]() |
0..1 | dateTime | The time when specimen was received for processing | |||||
![]() ![]() |
1..1 | Reference(US Public Health Specimen Profile) | Clinical specimen the organism was isolated from | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
![]() ![]() |
0..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 | |||||
![]() ![]() ![]() |
0..1 | (USCDI+) Specimen Collection Date/Time | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Duration | How long it took to collect specimen | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | The quantity of specimen collected Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI+) Specimen Source Site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() |
0..1 | Whether or how long patient abstained from food and/or drink Binding: Hl7VSRelevantClincialInformation (3.0.0) (extensible): Codes describing the fasting status of the patient. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Container volume or size Constraints: sqty-1 | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Quantity of specimen within container Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | Additive associated with container Binding: Hl7VSAdditivePreservative (3.0.0) (example): Substance added to specimen container. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() |
0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen. | |||||
![]() ![]() |
0..* | Annotation | Comments | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | extensible |
Specimen type
|
📍20240606 | VSAC v0.23 |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📍3.0.0 | THO v7.5 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📦4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📦4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.5 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📍3.0.0 | THO v7.5 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from USPublicHealthSpecimen
Summary
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron