International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips | Version: 2.0.0 | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: SpecimenUvIps |
This profile constrains the Specimen resource to represent the characteristics of a biological specimens in the context of laboratory results integrated to a patient summary.
Minimal specimen attributes, usable for the laboratory results section and entry of a patient summary.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis | |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(Patient (IPS)) | 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
| ||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard | |
Specimen.type | preferred | ResultsSpecimenTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ips From this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
Specimen | |||||||||||
![]() ![]() ![]() |
SO | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
| ||||||||
![]() ![]() ![]() |
SO | 0..1 | Reference(Patient (IPS)) | 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
| ||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() |
||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred) | |||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (preferred) | |||||||||
![]() |
Path | Conformance | ValueSet | URI |
Specimen.type | preferred | ResultsSpecimenTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ips From this IG | |
Specimen.collection.method | preferred | ResultsSpecimenCollectionMethodUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-collection-method-uv-ips From this IG | |
Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ips From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation 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 | Identifier assigned by the lab | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(Patient (IPS)) | 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
| ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||
![]() ![]() ![]() |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||||||
![]() ![]() ![]() |
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 | Collection time | |||||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | |||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred) | |||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (preferred) | |||||||||
![]() ![]() ![]() ![]() |
Σ | 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. | |||||||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|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 | preferred | ResultsSpecimenTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ips From this IG | ||||
Specimen.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 From the FHIR Standard | ||||
Specimen.collection.method | preferred | ResultsSpecimenCollectionMethodUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-collection-method-uv-ips From this IG | ||||
Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ips From this IG | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure|4.0.1 From the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type|4.0.1 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: 1 element(1 nested mandatory element)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis | |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(Patient (IPS)) | 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
| ||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard | |
Specimen.type | preferred | ResultsSpecimenTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ips From this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
Specimen | |||||||||||
![]() ![]() ![]() |
SO | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
| ||||||||
![]() ![]() ![]() |
SO | 0..1 | Reference(Patient (IPS)) | 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
| ||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() |
||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred) | |||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (preferred) | |||||||||
![]() |
Path | Conformance | ValueSet | URI |
Specimen.type | preferred | ResultsSpecimenTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ips From this IG | |
Specimen.collection.method | preferred | ResultsSpecimenCollectionMethodUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-collection-method-uv-ips From this IG | |
Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ips From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation 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 | Identifier assigned by the lab | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(Patient (IPS)) | 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
| ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||
![]() ![]() ![]() |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||||||
![]() ![]() ![]() |
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 | Collection time | |||||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | |||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred) | |||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (preferred) | |||||||||
![]() ![]() ![]() ![]() |
Σ | 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. | |||||||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|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 | preferred | ResultsSpecimenTypeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ips From this IG | ||||
Specimen.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 From the FHIR Standard | ||||
Specimen.collection.method | preferred | ResultsSpecimenCollectionMethodUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-specimen-collection-method-uv-ips From this IG | ||||
Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ips From this IG | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure|4.0.1 From the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type|4.0.1 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: 1 element(1 nested mandatory element)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron