HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

SpecimenProfile

 

The official URL for this profile is:

http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Specimen

A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities.

This profile builds on Specimen.

This profile was published on Fri Aug 17 00:00:00 UTC 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).

View the corresponding SpecimenModel logical model.

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

BC Mapping Source

This structure represents the following BC mapping definition:

cimi.entity.Specimen maps to Specimen:
  AccessionIdentifier maps to accessionIdentifier
  SpecimenStatus maps to status
  Type maps to type
  CollectionSource maps to subject
  CollectionSite.AnatomicalLocation maps to collection.bodySite
  CollectionMethod.CodeableConcept maps to collection.method
  SourceSpecimen maps to parent
  ReceivedTime maps to receivedTime
  SpecimenContainer.Identifier maps to container.identifier
  SpecimenContainer.Details maps to container.description
  SpecimenContainer.Type maps to container.type
  SpecimenContainer.Capacity maps to container.capacity
  SpecimenContainer.SpecimenQuantity maps to container.specimenQuantity
  SpecimenContainer.Additive maps to container.additive[x]

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*BC Specimen Profile
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... cimi-entity-CollectionTime-extension 0..1dateTime, PeriodBC CollectionTime Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-CollectionTime-extension
... cimi-entity-SpecimenTreatment-extension 0..*Reference(BC SpecimenTreatment Profile)BC SpecimenTreatment Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenTreatment-extension
... cimi-entity-HandlingRisk-extension 0..*CodeableConceptBC HandlingRisk Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-HandlingRisk-extension
... cimi-entity-SpecialHandling-extension 0..*CodeableConceptBC SpecialHandling Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecialHandling-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1AccessionIdentifierProfileIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type Σ1..1CodeableConceptKind of material that forms the specimen
Binding: v2 Specimen Type (required)
... subject Σ1..1Reference(US Core Patient Profile | BC Group Profile | US Core Device Profile | BC Substance Profile)Where the specimen came from. This may be from the patient(s) or from the environment or a device
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..1Reference(BC Specimen Profile)Specimen from which this specimen originated
... request 0..*Reference(ProcedureRequest)Why the specimen was collected
... collection I0..1BackboneElementCollection details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... collector Σ0..1Reference(Practitioner)Who collected the specimen
.... collected[x] Σ0..1dateTime, PeriodCollection time
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIR Specimen Collection Method (example)
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: BC AnatomicalLocationVS ValueSet (required)
... processing I0..*BackboneElementProcessing and processing step details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
.... additive 0..*Reference(Substance)Material used in the processing step
.... time[x] 0..1dateTime, PeriodDate and time of specimen processing
... container I0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..*IdentifierProfileId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainer (example)
.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, Reference(BC Substance Profile)Additive associated with container
Binding: v2 Additive/Preservative (example)
... note 0..*AnnotationComments

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

BC Mapping Source

This structure represents the following BC mapping definition:

cimi.entity.Specimen maps to Specimen:
  AccessionIdentifier maps to accessionIdentifier
  SpecimenStatus maps to status
  Type maps to type
  CollectionSource maps to subject
  CollectionSite.AnatomicalLocation maps to collection.bodySite
  CollectionMethod.CodeableConcept maps to collection.method
  SourceSpecimen maps to parent
  ReceivedTime maps to receivedTime
  SpecimenContainer.Identifier maps to container.identifier
  SpecimenContainer.Details maps to container.description
  SpecimenContainer.Type maps to container.type
  SpecimenContainer.Capacity maps to container.capacity
  SpecimenContainer.SpecimenQuantity maps to container.specimenQuantity
  SpecimenContainer.Additive maps to container.additive[x]

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*BC Specimen Profile
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... cimi-entity-CollectionTime-extension 0..1dateTime, PeriodBC CollectionTime Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-CollectionTime-extension
... cimi-entity-SpecimenTreatment-extension 0..*Reference(BC SpecimenTreatment Profile)BC SpecimenTreatment Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenTreatment-extension
... cimi-entity-HandlingRisk-extension 0..*CodeableConceptBC HandlingRisk Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-HandlingRisk-extension
... cimi-entity-SpecialHandling-extension 0..*CodeableConceptBC SpecialHandling Extension
URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecialHandling-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1AccessionIdentifierProfileIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type Σ1..1CodeableConceptKind of material that forms the specimen
Binding: v2 Specimen Type (required)
... subject Σ1..1Reference(US Core Patient Profile | BC Group Profile | US Core Device Profile | BC Substance Profile)Where the specimen came from. This may be from the patient(s) or from the environment or a device
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..1Reference(BC Specimen Profile)Specimen from which this specimen originated
... request 0..*Reference(ProcedureRequest)Why the specimen was collected
... collection I0..1BackboneElementCollection details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... collector Σ0..1Reference(Practitioner)Who collected the specimen
.... collected[x] Σ0..1dateTime, PeriodCollection time
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIR Specimen Collection Method (example)
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: BC AnatomicalLocationVS ValueSet (required)
... processing I0..*BackboneElementProcessing and processing step details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
.... additive 0..*Reference(Substance)Material used in the processing step
.... time[x] 0..1dateTime, PeriodDate and time of specimen processing
... container I0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..*IdentifierProfileId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainer (example)
.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, Reference(BC Substance Profile)Additive associated with container
Binding: v2 Additive/Preservative (example)
... note 0..*AnnotationComments

doco Documentation for this format

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

 

 

Constraints

IdPathDetailsRequirements
dom-2SpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1SpecimenIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4SpecimenIf 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-3SpecimenIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Specimen.collectionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Specimen.processingAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Specimen.containerAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())