OpenELIS GLOBAL2 Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://i-tech-uw.github.io/openelis-global-ig/StructureDefinition/open-elis-specimen | Version: 0.1.0 | |||
Draft as of 2024-12-11 | Computable Name: OpenElisSpecimen |
A Specimen Resource used for FHIR Exchange
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 | |
id | 0..1 | id | Logical id of this artifact | |
Slices for identifier | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | |
identifier:uuid | 1..1 | Identifier | External Identifier | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: https://demo.openelis-global.org/sampleItem_uuid | |
accessionIdentifier | 1..1 | Identifier | Identifier assigned by the lab | |
value | 0..1 | string | The value that is unique | |
status | 1..1 | code | available | unavailable | unsatisfactory | entered-in-error | |
type | 1..1 | CodeableConcept | Kind of material that forms the specimen | |
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
subject | 1..1 | Reference(OpenELIS 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 | |
receivedTime | 1..1 | dateTime | The time when specimen was received for processing | |
request | 1..1 | Reference(OpenELIS Service Request) | Why the specimen was collected | |
collection | 1..1 | BackboneElement | Collection details | |
Slices for collected[x] | 1..1 | dateTime | Collection time Slice: Unordered, Open by type:$this | |
collected[x]:collectedDateTime | 1..1 | dateTime | Collection time | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 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 | |
id | Σ | 0..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 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 |
Slices for identifier | Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:uuid | Σ | 1..1 | Identifier | External Identifier ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 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 |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://demo.openelis-global.org/sampleItem_uuid |
accessionIdentifier | Σ | 1..1 | Identifier | Identifier assigned by the lab ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 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 |
value | Σ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
status | ?!Σ | 1..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 |
type | Σ | 1..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 |
subject | Σ | 1..1 | Reference(OpenELIS 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 |
receivedTime | Σ | 1..1 | dateTime | The time when specimen was received for processing ele-1: All FHIR elements must have a @value or children |
request | 1..1 | Reference(OpenELIS Service Request) | Why the specimen was collected ele-1: All FHIR elements must have a @value or children | |
collection | 1..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children | |
modifierExtension | ?!Σ | 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 |
Slices for collected[x] | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
collected[x]:collectedDateTime | Σ | 1..1 | dateTime | Collection time ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.identifier:uuid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Specimen.accessionIdentifier.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 |
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() |
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | ||||
identifier:uuid | Σ | 1..1 | Identifier | External Identifier | ||||
id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://demo.openelis-global.org/sampleItem_uuid | ||||
value | Σ | 0..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 | Σ | 1..1 | Identifier | Identifier assigned by the lab | ||||
id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..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) | ||||
status | ?!Σ | 1..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: hl7VS-specimenType (example): The type of the specimen. | ||||
id | 0..1 | string | 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 | string | 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 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | Σ | 1..1 | Reference(OpenELIS 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 | ||||
receivedTime | Σ | 1..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
request | 1..1 | Reference(OpenELIS Service Request) | Why the specimen was collected | |||||
collection | 1..1 | BackboneElement | Collection details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
Slices for collected[x] | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this | ||||
collected[x]:collectedDateTime | Σ | 1..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. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
additive | 0..* | Reference(Substance) | Material used in the processing step | |||||
time[x] | 0..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.identifier:uuid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.identifier:uuid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Specimen.accessionIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.accessionIdentifier.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 | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
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 | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
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: 12 elements
Structures
This structure refers to these other structures:
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 | |
id | 0..1 | id | Logical id of this artifact | |
Slices for identifier | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | |
identifier:uuid | 1..1 | Identifier | External Identifier | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: https://demo.openelis-global.org/sampleItem_uuid | |
accessionIdentifier | 1..1 | Identifier | Identifier assigned by the lab | |
value | 0..1 | string | The value that is unique | |
status | 1..1 | code | available | unavailable | unsatisfactory | entered-in-error | |
type | 1..1 | CodeableConcept | Kind of material that forms the specimen | |
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
subject | 1..1 | Reference(OpenELIS 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 | |
receivedTime | 1..1 | dateTime | The time when specimen was received for processing | |
request | 1..1 | Reference(OpenELIS Service Request) | Why the specimen was collected | |
collection | 1..1 | BackboneElement | Collection details | |
Slices for collected[x] | 1..1 | dateTime | Collection time Slice: Unordered, Open by type:$this | |
collected[x]:collectedDateTime | 1..1 | dateTime | Collection time | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 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 | |
id | Σ | 0..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 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 |
Slices for identifier | Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:uuid | Σ | 1..1 | Identifier | External Identifier ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 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 |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://demo.openelis-global.org/sampleItem_uuid |
accessionIdentifier | Σ | 1..1 | Identifier | Identifier assigned by the lab ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 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 |
value | Σ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
status | ?!Σ | 1..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 |
type | Σ | 1..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 |
subject | Σ | 1..1 | Reference(OpenELIS 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 |
receivedTime | Σ | 1..1 | dateTime | The time when specimen was received for processing ele-1: All FHIR elements must have a @value or children |
request | 1..1 | Reference(OpenELIS Service Request) | Why the specimen was collected ele-1: All FHIR elements must have a @value or children | |
collection | 1..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children | |
modifierExtension | ?!Σ | 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 |
Slices for collected[x] | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
collected[x]:collectedDateTime | Σ | 1..1 | dateTime | Collection time ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.identifier:uuid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Specimen.accessionIdentifier.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 |
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() |
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:system | ||||
identifier:uuid | Σ | 1..1 | Identifier | External Identifier | ||||
id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://demo.openelis-global.org/sampleItem_uuid | ||||
value | Σ | 0..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 | Σ | 1..1 | Identifier | Identifier assigned by the lab | ||||
id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..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) | ||||
status | ?!Σ | 1..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: hl7VS-specimenType (example): The type of the specimen. | ||||
id | 0..1 | string | 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 | string | 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 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | Σ | 1..1 | Reference(OpenELIS 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 | ||||
receivedTime | Σ | 1..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
request | 1..1 | Reference(OpenELIS Service Request) | Why the specimen was collected | |||||
collection | 1..1 | BackboneElement | Collection details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
Slices for collected[x] | Σ | 1..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this | ||||
collected[x]:collectedDateTime | Σ | 1..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. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
additive | 0..* | Reference(Substance) | Material used in the processing step | |||||
time[x] | 0..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.identifier:uuid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.identifier:uuid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Specimen.accessionIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.accessionIdentifier.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 | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
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 | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
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: 12 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron