International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1 International flag

This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Specimen (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... type 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Specimen Type - IPS (preferred)
Additional BindingsPurpose
Results Specimen Type - SNOMED CT IPS Free SetCandidate Validation Binding
... subject 0..1Reference(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
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... collection 0..1BackboneElementCollection details
.... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: FHIRSpecimenCollectionMethod (preferred)
.... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Body Site - IPS (preferred)
.... fastingStatus[x] 0..1Whether or how long patient abstained from food and/or drink
..... fastingStatusCodeableConceptCodeableConcept(CodeableConceptIPS)
..... fastingStatusDurationDuration

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Specimen.typepreferredResultsSpecimenTypeUvIps
Additional Bindings Purpose Documentation
Results Specimen Type - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a specimen type value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
Specimen.collection.methodpreferredFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredBodySiteUvIps
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... subject Σ0..1Reference(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
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: FHIRSpecimenCollectionMethod (preferred)
.... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Body Site - IPS (preferred)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept(CodeableConceptIPS)
..... fastingStatusDurationDuration

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredResultsSpecimenTypeUvIps
Additional Bindings Purpose Documentation
Results Specimen Type - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a specimen type value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
Specimen.collection.methodpreferredFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredBodySiteUvIps
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf 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-4errorSpecimenIf 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-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Specimen Type - IPS (preferred)
Additional BindingsPurpose
Results Specimen Type - SNOMED CT IPS Free SetCandidate Validation Binding
... subject Σ0..1Reference(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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: FHIRSpecimenCollectionMethod (preferred)
.... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Body Site - IPS (preferred)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept(CodeableConceptIPS)
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates 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..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredResultsSpecimenTypeUvIps
Additional Bindings Purpose Documentation
Results Specimen Type - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a specimen type value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
Specimen.subject.typeextensibleResourceType
Specimen.collection.methodpreferredFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredBodySiteUvIps
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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)

Structures

This structure refers to these other structures:

Maturity: 2

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... type 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Specimen Type - IPS (preferred)
Additional BindingsPurpose
Results Specimen Type - SNOMED CT IPS Free SetCandidate Validation Binding
... subject 0..1Reference(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
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... collection 0..1BackboneElementCollection details
.... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: FHIRSpecimenCollectionMethod (preferred)
.... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Body Site - IPS (preferred)
.... fastingStatus[x] 0..1Whether or how long patient abstained from food and/or drink
..... fastingStatusCodeableConceptCodeableConcept(CodeableConceptIPS)
..... fastingStatusDurationDuration

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Specimen.typepreferredResultsSpecimenTypeUvIps
Additional Bindings Purpose Documentation
Results Specimen Type - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a specimen type value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
Specimen.collection.methodpreferredFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredBodySiteUvIps

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... subject Σ0..1Reference(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
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: FHIRSpecimenCollectionMethod (preferred)
.... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Body Site - IPS (preferred)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept(CodeableConceptIPS)
..... fastingStatusDurationDuration

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredResultsSpecimenTypeUvIps
Additional Bindings Purpose Documentation
Results Specimen Type - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a specimen type value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
Specimen.collection.methodpreferredFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredBodySiteUvIps
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf 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-4errorSpecimenIf 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-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Specimen Type - IPS (preferred)
Additional BindingsPurpose
Results Specimen Type - SNOMED CT IPS Free SetCandidate Validation Binding
... subject Σ0..1Reference(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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: FHIRSpecimenCollectionMethod (preferred)
.... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Body Site - IPS (preferred)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept(CodeableConceptIPS)
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates 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..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredResultsSpecimenTypeUvIps
Additional Bindings Purpose Documentation
Results Specimen Type - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a specimen type value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
Specimen.subject.typeextensibleResourceType
Specimen.collection.methodpreferredFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredBodySiteUvIps
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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)

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron