Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Specimen

National Pathology FHIR Message Profiles

Specimen Overview

Contains data on the specimen that was provided for testing. Where a single type of specimen (for example blood) is split into multiple containers it is treated as multiple specimens.

Mapping for Specimen

How to populate the Specimen instance to conform to the profiles below:

Level 1 Specimen Resource Level 2 CareConnect-Specimen-1 Level 3 None
View Used FHIR Elements   View All FHIR Elements

Note: Hover over name to see data item name.

Name Card. Business Conformance Type Description, Constraints and mapping for National Pathology Implementation
- id 0..1 Mandatory Id Logical id of this artifact
Must contain a UUID to identify the instance of a specimen
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Specimen-1'
- extension (fastingStatus) 0..1 Required Extension-CareConnect-FastingStatus-1 Fasting Status
Constraint (ext-1): Must have either extensions or value[x], not both
Details of the fasting status of the patient at time of specimen collection
- identifier 0..1 Mandatory Identifier External Identifier
A business level identifier for the specimen supplied by the collecting/requesting organisation. eg. GP Practice
- - system 1..1 Mandatory Uri The namespace for the identifier value
MUST contain the value 'https://tools.ietf.org/html/rfc4122'.
- - value 1..1 Mandatory String The value that is unique
MUST contain a UUID
- accessionIdentifier 0..1 Mandatory Identifier Identifier assigned by the lab
A business level identifier for the specimen supplied by the performing organisation. eg. Lab performing the test.
- status 0..1 Required Code available : unavailable : unsatisfactory : entered-in-error
Binding (required): Codes providing the status/availability of a specimen. (http://hl7.org/fhir/stu3/valueset-specimen-status.html )
- type 0..1 Required CodeableConcept Kind of material that forms the specimen
Binding (required): The type of the specimen. ( https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SpecimenType-1 )
- - coding 0..* Required Coding Code defined by a terminology system
- - - system 1..1 Mandatory Uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
- - - code 1..1 Mandatory Code Symbol in syntax defined by the system
Code MUST be from:
(<105590001 :Substance (substance):(in which case method and site should also be populated)OR
<49755003 :Morphologically abnormal structure (morphologic abnormality):OR
< 260787004 :Physical object (physical object))
- - - display 1..1 Mandatory String Representation defined by the system
MUST contain a SNOMED CT display name that matches to its equivalent SNOMED CT code
- - text 0..1 Optional String Plain text representation of the concept
- subject 1..1 Mandatory Reference Where the specimen came from. This may be from the patient(s) or from the environment or a device
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Patient-1 This MUST be to the patient resource profiled as CareConnect-Patient-1
- receivedTime 0..1 Required dateTime The time when specimen was received for processing
The date and time on which the specimen was received for processing.
- collection 0..1 Mandatory BackboneElement Collection details
- - collector 0..1 Required Reference Who collected the specimen
Constraint (ref-1): SHALL have a contained resource if a local reference is provided This MUST be a reference to either the Practitioner resource
  0..1 Required CareConnect-Practitioner-1 The responsible clinician for the encounter. This MUST use the CareConnect Practitioner profile.
- - reference 0..1 Required String Literal reference, Relative, internal or absolute URL
A reference to the practitioner resource included in the FHIR message bundle.
- - collected[x] 0..1 Required dateTime Collection time
The date and time on which the specimen was collected.
- - quantity 0..1 Required Quantity ( SimpleQuantity ) The quantity of specimen collected
Constraint (qty-3): If a code for the unit is present, the system SHALL also be present
Constraint (sqty-1): The comparator is not used on a SimpleQuantity
- - - value 0..1 Required Decimal Numerical value (with implicit precision)
Collected Specimen Quantity
- - - unit 0..1 Required String Unit representation
Collected Specimen Quantity Unit of Measure Text
- - - bodySite 0..1 Optional CodeableConcept Anatomical collection site
Binding (required): Codes describing anatomical locations. May include laterality. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SpecimenBodySite-1 )
- - - - coding 0..* Optional Coding Code defined by a terminology system
- - - - - system 1..1 Required Uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
- - - - - code 1..1 Mandatory Code Symbol in syntax defined by the system
MUST be code from: < 442083009 : Anatomical or acquired body structure
OR < 49755003 : Morphologically abnormal structure
- - - - - display 1..1 Mandatory String Representation defined by the system
MUST contain a SNOMED CT display name that matches to its equivalent SNOMED CT code
- - - - text 0..1 Optional String Plain text representation of the concept
- note 0..* Optional Annotation Comments
Notes/comments relating to the specimen taken by the collection and/or performing organisation or HCP.
- - author[x] 0..1 Optional String Individual responsible for the annotation
Constraint (ref-1): SHALL have a contained resource if a local reference is provided This MUST be a reference to either the Practitioner resource
  0..1 Required CareConnect-Practitioner-1 The responsible clinician for the encounter. This MUST use the CareConnect Practitioner profile.
- - reference 0..1 Required String Literal reference, Relative, internal or absolute URL
A reference to the practitioner resource included in the FHIR message bundle.
- - time 0..1 Required dateTime When the annotation was made
- - text 1..1 Mandatory String The annotation - text content

Specimen Example(s)

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated