FHIR Implementation Guide for NDHM CI Build v2.0
banner

NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.

StructureDefinition-Specimen

This profile sets minimum expectations for the Specimen resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Specimen

This profile builds on Specimen

Summary

Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... type 0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (example)
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... subject 0..1Reference(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
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... receivedTime S1..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
.... collector 0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] 1..1dateTimeCollection time

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*SpecimenSample for analysis
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Identifier
... accessionIdentifier ΣI0..1IdentifierIdentifier assigned by the lab
... status ?!ΣI0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type ΣI0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... subject ΣI0..1Reference(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
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... receivedTime SΣI1..1dateTimeThe time when specimen was received for processing
... parent I0..*Reference(Specimen)Specimen from which this specimen originated
... request I0..*Reference(ServiceRequest)Why the specimen was collected
... collection I0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector ΣI0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] ΣI1..1dateTimeCollection time
.... duration ΣI0..1DurationHow long it took to collect specimen
.... quantity I0..1SimpleQuantityThe quantity of specimen collected
.... method I0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example)
.... bodySite I0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example)
.... fastingStatus[x] ΣI0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible)
..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing I0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I0..1stringTextual description of procedure
.... procedure I0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
.... additive I0..*Reference(Substance)Material used in the processing step
.... time[x] I0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container I0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier ΣI0..*IdentifierId for the container
.... description I0..1stringTextual description of the container
.... type I0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example)
.... capacity I0..1SimpleQuantityContainer volume or size
.... specimenQuantity I0..1SimpleQuantityQuantity of specimen within container
.... additive[x] I0..1Additive associated with container
Binding: hl7VS-additivePreservative (example)
..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition ΣI0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible)
... note I0..*AnnotationComments

doco Documentation for this format

Summary

Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... type 0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (example)
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... subject 0..1Reference(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
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... receivedTime S1..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
.... collector 0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] 1..1dateTimeCollection time

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*SpecimenSample for analysis
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Identifier
... accessionIdentifier ΣI0..1IdentifierIdentifier assigned by the lab
... status ?!ΣI0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type ΣI0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... subject ΣI0..1Reference(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
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... receivedTime SΣI1..1dateTimeThe time when specimen was received for processing
... parent I0..*Reference(Specimen)Specimen from which this specimen originated
... request I0..*Reference(ServiceRequest)Why the specimen was collected
... collection I0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector ΣI0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] ΣI1..1dateTimeCollection time
.... duration ΣI0..1DurationHow long it took to collect specimen
.... quantity I0..1SimpleQuantityThe quantity of specimen collected
.... method I0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example)
.... bodySite I0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example)
.... fastingStatus[x] ΣI0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible)
..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing I0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I0..1stringTextual description of procedure
.... procedure I0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
.... additive I0..*Reference(Substance)Material used in the processing step
.... time[x] I0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container I0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier ΣI0..*IdentifierId for the container
.... description I0..1stringTextual description of the container
.... type I0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example)
.... capacity I0..1SimpleQuantityContainer volume or size
.... specimenQuantity I0..1SimpleQuantityQuantity of specimen within container
.... additive[x] I0..1Additive associated with container
Binding: hl7VS-additivePreservative (example)
..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition ΣI0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible)
... note I0..*AnnotationComments

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron