Diagnostic Data Services

DDS-Report-Specimen-1

The FHIR Specimen Resource is defined as a sample to be used for analysis. Scope and usage extends to any material sample which is taken from a biological entity, living or dead or taken from a physical object or the environment. Some specimens are biological and can contain one or more components including but not limited to cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory products (source: NCI Thesaurus , modified). The specimen resource covers substances used for diagnostic and environmental testing.

NameCard.TypeDescription & Constraints
..SpecimenSpecimenSample for analysis

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...identifier0..1IdentifierExternal Identifier

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required
Example Value official

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....system1..1UriThe namespace for the identifier
Example Value http://mmp.nhs.uk/id/specimen-id

....value1..1StringThe value that is unique
Example Value b603cede-8c3f-4909-9cb1-d47c0fde9f8a

....period0..1PeriodTime period when id is/was valid for use

.....id0..1Idxml:id (or equivalent in JSON)

.....start1..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (Organization)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

.....reference1..1StringRelative URL reference
Example Value Organisation/78d64bb3-b5b2-450b-aeb7-d9035ebc711d

.....display0..1StringText alternative for the resource
Example Value MGP Medical Centre

...status0..1Codeavailable | unavailable | unsatisfactory | entered-in-error
Binding Codes providing the status/availability of a specimen. (http://hl7.org/fhir/ValueSet/specimen-status)
Binding Strength Required

...type0..1CodeableConceptKind of material that forms the specimen
Binding The type of the specimen. (http://snomed.info/sct)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding0..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

.....version0..1StringVersion of the system - if relevant
Example Value 20150731

.....code1..1CodeSymbol in syntax defined by the system
Example Value 119297000

.....display1..1StringRepresentation defined by the system
Example Value Blood specimen

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...parent0..*Reference (Specimen)Specimen from which this specimen originated

....id0..1Idxml:id (or equivalent in JSON)

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...subject1..1Reference (CareConnect-Patient-1 | Group | Device | Substance)Where the specimen came from. This may be from the patient(s) or from the environment or a device

...accessionIdentifier0..1IdentifierIdentifier assigned by the lab

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....system1..1UriThe namespace for the identifier
Example Value http://www.sampleth.nhs.uk/pathology/BloodSciences/labno

....value1..1StringThe value that is unique
Example Value HAEM8667800001

....period0..1PeriodTime period when id is/was valid for use

.....id0..1Idxml:id (or equivalent in JSON)

.....start1..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (Organization)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

.....reference1..1StringRelative URL reference
Example Value Organization/223f5c66-66bf-4cea-a5d7-25ab9348b448

.....display0..1StringText alternative for the resource

...receivedTime0..1DateTimeThe time when specimen was received for processing

...collection0..1BackboneElementCollection details

....id0..1Idxml:id (or equivalent in JSON)

....collector0..1Reference (CareConnect-Practitioner-1)Who collected the specimen

.....id0..1Idxml:id (or equivalent in JSON)

.....reference1..1StringRelative URL reference
Example Value Practitioner/4bfca0ef-85d0-4c5e-b662-d4910bb83d82

.....display0..1StringText alternative for the resource
Example Value Dr. Jones

....comment0..*StringCollector comments

....collected[x]0..1DateTime | PeriodCollection time

....quantity (SimpleQuantity)0..1SimpleQuantityThe quantity of specimen collected

.....id0..1Idxml:id (or equivalent in JSON)

.....value1..1DecimalNumerical value (with implicit precision)
Example Value 6

.....unit1..1StringUnit representation
Example Value millilitre

.....system1..1UriSystem that defines coded unit form
Example Value http://unitsofmeasure.org

.....code1..1CodeCoded form of the unit
Example Value mL

....method0..1CodeableConceptTechnique used to perform collection
Binding The technique that is used to perform the procedure (http://snomed.info/sct)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system
Example Value 32564009

......display1..1StringRepresentation defined by the system
Example Value arterial specimen collection for laboratory test

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....bodySite0..1CodeableConceptAnatomical collection site
Binding Codes describing anatomical locations. May include laterality. (http://hl7.org/fhir/ValueSet/body-site)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system
Fixed Value http://hl7.org/fhir/ValueSet/body-site

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system
Example Value 308046002

......display1..1StringRepresentation defined by the system
Example Value Structure of superficial forearm vein

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

...treatment0..*BackboneElementTreatment and processing step details

....id0..1Idxml:id (or equivalent in JSON)

....description0..1StringTextual description of procedure
Example Value Treated with anticoagulants.

....procedure0..1CodeableConceptIndicates the treatment or processing step applied to the specimen
Binding Type indicating the technique used to process the specimen (http://hl7.org/fhir/ValueSet/specimen-treatment-procedure)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....additive0..*Reference (Substance)Material used in the processing step

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

...container0..*BackboneElementDirect container of specimen (tube/slide, etc.)

....id0..1Idxml:id (or equivalent in JSON)

....identifier0..1IdentifierId for the container

.....id0..1Idxml:id (or equivalent in JSON)

.....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required

.....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

......id0..1Idxml:id (or equivalent in JSON)

......coding0..1CodingCode defined by a terminology system

.......id0..1Idxml:id (or equivalent in JSON)

.......system1..1UriIdentity of the terminology system

.......version0..1StringVersion of the system - if relevant

.......code1..1CodeSymbol in syntax defined by the system

.......display1..1StringRepresentation defined by the system

.......userSelected0..1BooleanIf this coding was chosen directly by the user

......text0..1StringPlain text representation of the concept

.....system1..1UriThe namespace for the identifier
Example Value http://mmp.nhs.uk/id/container-id

.....value1..1StringThe value that is unique
Example Value 08fc96c4-eb3a-46d3-93c5-4b23792dcc1c

.....period0..1PeriodTime period when id is/was valid for use

......id0..1Idxml:id (or equivalent in JSON)

......start1..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

.....assigner0..1Reference (CareConnect-Organization-1)Organization that issued id (may be just text)

......id0..1Idxml:id (or equivalent in JSON)

......reference0..1StringRelative, internal or absolute URL reference

......display0..1StringText alternative for the resource

....description0..1StringTextual description of the container

....type0..1CodeableConceptKind of container directly associated with specimen
Binding Type of specimen container (http://snomed.info/sct)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

......version0..1StringVersion of the system - if relevant
Example Value 20150731

......code1..1CodeSymbol in syntax defined by the system
Example Value 434746001

......display1..1StringRepresentation defined by the system
Example Value Specimen vial

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....capacity (SimpleQuantity)0..1SimpleQuantityContainer volume or size

.....id0..1Idxml:id (or equivalent in JSON)

.....value1..1DecimalNumerical value (with implicit precision)
Example Value 10

.....unit1..1StringUnit representation
Example Value millilitre

.....system1..1UriSystem that defines coded unit form
Example Value http://unitsofmeasure.org

.....code1..1CodeCoded form of the unit
Example Value mL

....specimenQuantity (SimpleQuantity)0..1SimpleQuantityQuantity of specimen within container

.....id0..1Idxml:id (or equivalent in JSON)

.....value1..1DecimalNumerical value (with implicit precision)
Example Value 6

.....unit1..1StringUnit representation
Example Value millilitre

.....system1..1UriSystem that defines coded unit form
Example Value http://unitsofmeasure.org

.....code1..1CodeCoded form of the unit
Example Value mL

....additiveReference0..1Reference (Substance)Additive associated with container
Binding Substance added to specimen container (http://hl7.org/fhir/ValueSet/v2-0371)
Binding Strength Example

Path Name Binding Strength ValueSet
.Specimen.language language Required http://tools.ietf.org/html/bcp47
.Specimen.identifier.use use Required http://hl7.org/fhir/ValueSet/identifier-use
.Specimen.identifier.type type Extensible http://hl7.org/fhir/ValueSet/identifier-type
.Specimen.status status Required http://hl7.org/fhir/ValueSet/specimen-status
.Specimen.type type Example http://snomed.info/sct
.Specimen.collection.method method Example http://snomed.info/sct
.Specimen.collection.bodySite bodySite Example http://hl7.org/fhir/ValueSet/body-site
.Specimen.treatment.procedure procedure Example http://hl7.org/fhir/ValueSet/specimen-treatment-procedure
.Specimen.container.additiveReference additiveReference Example http://hl7.org/fhir/ValueSet/v2-0371

DDS-Report-Specimen-1

Examples Description XML File
DDS-Report-Specimen-1-Ex01 An example of a blood specimen for Diagnostic Data Services.
DDS-Report-Specimen-1-Ex02 An example of a cervical smear specimen for Diagnostic Data Services