HL7 BE Laboratory Result WG Implementation Guide (work in progress)
0.0.7 - CI Build

HL7 BE Laboratory Result WG Implementation Guide (work in progress), published by HL7 Belgium. This is not an authorized publication; it is the continuous build for version 0.0.7). This version is based on the current content of https://github.com/hl7-be/hl7-be-fhir-laboratory-report/ and changes regularly. See the Directory of published versions

Resource Profile: BeSpecimenLaboratory

Official URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-specimen-laboratory Version: 0.0.7
Draft as of 2021-11-08 Responsible: HL7 Belgium Realm: International flag Computable Name: BeSpecimenLaboratory

Belgian profile for a specimen in a laboratory report. In some laboratory reports, specimen information is allowed to be minimal as many informations concerning the specimen are implied by the observations done.

Usage:

  • Refer to this Resource Profile:
  • Examples for this Resource Profile: Specimen/urine1

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
... text
.... status 1..1codegenerated | extensions | additional | empty
Required Pattern: empty
... identifier S0..*IdentifierExternal Identifier
... status S0..1codeavailable | unavailable | unsatisfactory | entered-in-error
... subject S0..1Reference(Group | Device | Substance | Location | BePatient)In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... parent S0..*Reference(BeSpecimenLaboratory)Specimen from which this specimen originated
... request S0..*Reference(ServiceRequest)Why the specimen was collected
... collection S0..1BackboneElementCollection details
.... collected[x] 0..1dateTime, PeriodCollection time
.... duration 0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
.... bodySite 0..1CodeableConceptAnatomical collection site
.... fastingStatus[x] 0..1CodeableConcept, DurationWhether or how long patient abstained from food and/or drink
... processing 0..*BackboneElementProcessing and processing step details to include when not implicit from specimen.
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
... condition S0..*CodeableConceptState of the specimen
... note S0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1stringLogical 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
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1codegenerated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.


Required Pattern: empty
.... div I1..1xhtmlLimited xhtml content
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!SΣ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ0..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.

... subject SΣ0..1Reference(Group | Device | Substance | Location | BePatient)In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent S0..*Reference(BeSpecimenLaboratory)Specimen from which this specimen originated
... request S0..*Reference(ServiceRequest)Why the specimen was collected
... collection S0..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..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... 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
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details to include when not implicit from specimen.
.... 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 SΣ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note S0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... identifier Σ0..*IdentifierExternal Identifier
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type Σ0..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.

... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(BeSpecimenLaboratory)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
... 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

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... text
.... status 1..1codegenerated | extensions | additional | empty
Required Pattern: empty
... identifier S0..*IdentifierExternal Identifier
... status S0..1codeavailable | unavailable | unsatisfactory | entered-in-error
... subject S0..1Reference(Group | Device | Substance | Location | BePatient)In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... parent S0..*Reference(BeSpecimenLaboratory)Specimen from which this specimen originated
... request S0..*Reference(ServiceRequest)Why the specimen was collected
... collection S0..1BackboneElementCollection details
.... collected[x] 0..1dateTime, PeriodCollection time
.... duration 0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
.... bodySite 0..1CodeableConceptAnatomical collection site
.... fastingStatus[x] 0..1CodeableConcept, DurationWhether or how long patient abstained from food and/or drink
... processing 0..*BackboneElementProcessing and processing step details to include when not implicit from specimen.
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
... condition S0..*CodeableConceptState of the specimen
... note S0..*AnnotationComments

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1stringLogical 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
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1codegenerated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.


Required Pattern: empty
.... div I1..1xhtmlLimited xhtml content
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!SΣ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ0..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.

... subject SΣ0..1Reference(Group | Device | Substance | Location | BePatient)In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent S0..*Reference(BeSpecimenLaboratory)Specimen from which this specimen originated
... request S0..*Reference(ServiceRequest)Why the specimen was collected
... collection S0..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..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... 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
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details to include when not implicit from specimen.
.... 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 SΣ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note S0..*AnnotationComments

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Specimen.languagepreferredCommonLanguages
Max Binding: AllLanguages
Specimen.text.statusrequiredPattern: empty
Specimen.statusrequiredSpecimenStatus
Specimen.typeexampleHl7VSSpecimenType
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
Specimen.collection.bodySiteexampleSNOMEDCTBodyStructures
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

Constraints

IdGradePathDetailsRequirements
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-1errorSpecimen.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.text.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.text.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.text.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.text.divAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
txt-1errorSpecimen.text.divThe narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
: htmlChecks()
txt-2errorSpecimen.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()
ele-1errorSpecimen.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.accessionIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.receivedTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.parentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collectionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.collection.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.collection.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.collection.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.collection.collectorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.collected[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.durationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.quantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.fastingStatus[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.processing.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.processing.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.processing.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.processing.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.procedureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.additiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.time[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.containerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.container.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.container.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.container.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.container.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.capacityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.specimenQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.additive[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())