Standard Health Record

BreastSpecimenProfile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-oncology-BreastSpecimen

Specimen resulting from biopsy or excision of breast and surrounding tissue.

This profile builds on Specimen.

This profile was published on Wed Aug 22 00:00:00 EDT 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Specimen.processing is sliced based on the value of value:procedure
  • The element Specimen.processing.procedure.coding is sliced based on the value of value:code

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.oncology.BreastSpecimen maps to Specimen:
  AccessionIdentifier maps to accessionIdentifier
  SpecimenStatus maps to status
  Type maps to type
  SubjectOfInformation maps to subject  
  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]
  ColdIschemiaTime maps to processing (slice on = procedure)
  ColdIschemiaTime.TimePeriod maps to processing.time[x]
  ColdIschemiaTime._Concept maps to processing.procedure
  constrain processing.additive to 0..0

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen SHR BreastSpecimen Profile
... cimi-entity-CollectionTime-extension 0..1dateTime, PeriodSHR CollectionTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionTime-extension
... cimi-entity-CollectionMethod-extension 0..1CodeableConceptProfileSHR CollectionMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionMethod-extension
.... valueCodeableConcept Binding: SHR BreastSpecimenCollectionMethodVS ValueSet (required)
... cimi-entity-CollectionSite-extension 0..1Reference(SHR AnatomicalLocation Profile)SHR CollectionSite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionSite-extension
... cimi-entity-SpecimenTreatment-extension 0..*Reference(SHR SpecimenTreatment Profile)SHR SpecimenTreatment Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-SpecimenTreatment-extension
... cimi-entity-HandlingRisk-extension 0..*CodeableConceptProfileSHR HandlingRisk Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-HandlingRisk-extension
... cimi-entity-SpecialHandling-extension 0..*CodeableConceptProfileSHR SpecialHandling Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-SpecialHandling-extension
... accessionIdentifier AccessionIdentifierProfile
... type 1..1CodeableConceptProfileBinding: SHR BreastSpecimenTypeVS ValueSet (required)
... subject Reference(SHR Patient Profile)
... parent 0..1Reference(SHR BreastSpecimen Profile)
... processing Slice: Unordered, Open by value:procedure
... processing 0..1ColdIschemiaTime
.... procedure CodeableConceptProfile
..... coding Slice: Unordered, Open by value:code
..... coding Σ1..1CodingProfile
...... system Fixed Value: http://loinc.org
...... code Fixed Value: 44778-9
.... additive 0..0
.... timePeriod Period
... container
.... identifier IdentifierProfile
.... type CodeableConceptProfile
.... capacity SimpleQuantityProfile
.... specimenQuantity SimpleQuantityProfile
.... additive[x] CodeableConceptProfile, Reference(SHR Substance Profile)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*SHR BreastSpecimen 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)
... 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, PeriodSHR CollectionTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionTime-extension
... cimi-entity-CollectionMethod-extension 0..1CodeableConceptProfileSHR CollectionMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionMethod-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionMethod-extension"
.... valueCodeableConcept 1..1CodeableConceptProfileValue of extension
Binding: SHR BreastSpecimenCollectionMethodVS ValueSet (required)
... cimi-entity-CollectionSite-extension 0..1Reference(SHR AnatomicalLocation Profile)SHR CollectionSite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionSite-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionSite-extension"
.... valueReference 1..1Reference(SHR AnatomicalLocation Profile)Value of extension
... cimi-entity-SpecimenTreatment-extension 0..*Reference(SHR SpecimenTreatment Profile)SHR SpecimenTreatment Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-SpecimenTreatment-extension
... cimi-entity-HandlingRisk-extension 0..*CodeableConceptProfileSHR HandlingRisk Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-HandlingRisk-extension
... cimi-entity-SpecialHandling-extension 0..*CodeableConceptProfileSHR SpecialHandling Extension
URL: http://standardhealthrecord.org/fhir/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..1CodeableConceptProfileKind of material that forms the specimen
Binding: SHR BreastSpecimenTypeVS ValueSet (required)
... subject Σ1..1Reference(SHR Patient 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(SHR BreastSpecimen 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: SNOMED CT Body Structures (example)
... processing IBackboneElementProcessing and processing step details
Slice: Unordered, Open by value:procedure
... processing I0..1BackboneElementColdIschemiaTime
.... 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..1CodeableConceptProfileIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingProfileCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding Σ1..1CodingProfile
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 44778-9
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... timePeriod 0..1PeriodDate 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..1CodeableConceptProfileKind of container directly associated with specimen
Binding: SpecimenContainer (example)
.... capacity 0..1SimpleQuantityProfileContainer volume or size
.... specimenQuantity 0..1SimpleQuantityProfileQuantity of specimen within container
.... additive[x] 0..1CodeableConceptProfile, Reference(SHR Substance Profile)Additive associated with container
Binding: v2 Additive/Preservative (example)
... note 0..*AnnotationComments

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Specimen.processing is sliced based on the value of value:procedure
  • The element Specimen.processing.procedure.coding is sliced based on the value of value:code

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.oncology.BreastSpecimen maps to Specimen:
  AccessionIdentifier maps to accessionIdentifier
  SpecimenStatus maps to status
  Type maps to type
  SubjectOfInformation maps to subject  
  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]
  ColdIschemiaTime maps to processing (slice on = procedure)
  ColdIschemiaTime.TimePeriod maps to processing.time[x]
  ColdIschemiaTime._Concept maps to processing.procedure
  constrain processing.additive to 0..0

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen SHR BreastSpecimen Profile
... cimi-entity-CollectionTime-extension 0..1dateTime, PeriodSHR CollectionTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionTime-extension
... cimi-entity-CollectionMethod-extension 0..1CodeableConceptProfileSHR CollectionMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionMethod-extension
.... valueCodeableConcept Binding: SHR BreastSpecimenCollectionMethodVS ValueSet (required)
... cimi-entity-CollectionSite-extension 0..1Reference(SHR AnatomicalLocation Profile)SHR CollectionSite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionSite-extension
... cimi-entity-SpecimenTreatment-extension 0..*Reference(SHR SpecimenTreatment Profile)SHR SpecimenTreatment Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-SpecimenTreatment-extension
... cimi-entity-HandlingRisk-extension 0..*CodeableConceptProfileSHR HandlingRisk Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-HandlingRisk-extension
... cimi-entity-SpecialHandling-extension 0..*CodeableConceptProfileSHR SpecialHandling Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-SpecialHandling-extension
... accessionIdentifier AccessionIdentifierProfile
... type 1..1CodeableConceptProfileBinding: SHR BreastSpecimenTypeVS ValueSet (required)
... subject Reference(SHR Patient Profile)
... parent 0..1Reference(SHR BreastSpecimen Profile)
... processing Slice: Unordered, Open by value:procedure
... processing 0..1ColdIschemiaTime
.... procedure CodeableConceptProfile
..... coding Slice: Unordered, Open by value:code
..... coding Σ1..1CodingProfile
...... system Fixed Value: http://loinc.org
...... code Fixed Value: 44778-9
.... additive 0..0
.... timePeriod Period
... container
.... identifier IdentifierProfile
.... type CodeableConceptProfile
.... capacity SimpleQuantityProfile
.... specimenQuantity SimpleQuantityProfile
.... additive[x] CodeableConceptProfile, Reference(SHR Substance Profile)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*SHR BreastSpecimen 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)
... 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, PeriodSHR CollectionTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionTime-extension
... cimi-entity-CollectionMethod-extension 0..1CodeableConceptProfileSHR CollectionMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionMethod-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionMethod-extension"
.... valueCodeableConcept 1..1CodeableConceptProfileValue of extension
Binding: SHR BreastSpecimenCollectionMethodVS ValueSet (required)
... cimi-entity-CollectionSite-extension 0..1Reference(SHR AnatomicalLocation Profile)SHR CollectionSite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionSite-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-CollectionSite-extension"
.... valueReference 1..1Reference(SHR AnatomicalLocation Profile)Value of extension
... cimi-entity-SpecimenTreatment-extension 0..*Reference(SHR SpecimenTreatment Profile)SHR SpecimenTreatment Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-SpecimenTreatment-extension
... cimi-entity-HandlingRisk-extension 0..*CodeableConceptProfileSHR HandlingRisk Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/cimi-entity-HandlingRisk-extension
... cimi-entity-SpecialHandling-extension 0..*CodeableConceptProfileSHR SpecialHandling Extension
URL: http://standardhealthrecord.org/fhir/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..1CodeableConceptProfileKind of material that forms the specimen
Binding: SHR BreastSpecimenTypeVS ValueSet (required)
... subject Σ1..1Reference(SHR Patient 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(SHR BreastSpecimen 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: SNOMED CT Body Structures (example)
... processing IBackboneElementProcessing and processing step details
Slice: Unordered, Open by value:procedure
... processing I0..1BackboneElementColdIschemiaTime
.... 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..1CodeableConceptProfileIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingProfileCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding Σ1..1CodingProfile
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 44778-9
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... timePeriod 0..1PeriodDate 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..1CodeableConceptProfileKind of container directly associated with specimen
Binding: SpecimenContainer (example)
.... capacity 0..1SimpleQuantityProfileContainer volume or size
.... specimenQuantity 0..1SimpleQuantityProfileQuantity of specimen within container
.... additive[x] 0..1CodeableConceptProfile, Reference(SHR 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

 

Terminology Bindings

PathNameConformanceValueSet
Specimen.languageCommon LanguagesextensibleCommon Languages
Specimen.extension.valueCodeableConceptSHR BreastSpecimenCollectionMethodVS ValueSetrequiredBreastSpecimenCollectionMethodVS
Specimen.statusSpecimenStatusrequiredSpecimenStatus
Specimen.typeSHR BreastSpecimenTypeVS ValueSetrequiredBreastSpecimenTypeVS
Specimen.collection.methodFHIR Specimen Collection MethodexampleFHIR Specimen Collection Method
Specimen.collection.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Specimen.processing.procedureSpecimenProcessingProcedureexampleSpecimenProcessingProcedure
Specimen.container.typeSpecimenContainerexampleSpecimenContainer
Specimen.container.additive[x]v2 Additive/Preservativeexamplev2 Additive/Preservative

 

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.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())