STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-specimen

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-specimen

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*Sample for analysis
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierExternal Identifier
... accessionIdentifier ∑0..1IdentifierIdentifier assigned by the lab
... status ?!∑0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type S0..1CodeableConceptKind of material that forms the specimen
Binding: v2 Specimen Type (example)
... subject S1..1Reference(Profile qicore-patient | Profile qicore-device | Profile qicore-substance | Group)Where the specimen came from. This may be from the patient(s) or from the environment or a device
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Profile qicore-specimen)Specimen from which this specimen originated
... request 0..*Reference(DiagnosticRequest | ProcedureRequest)Why the specimen was collected
... collection 0..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(Profile qicore-practitioner)A person with a formal responsibility in the provisioning of healthcare or related services
.... collected[x] S0..1dateTime, PeriodCollection time
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: SpecimenCollectionMethod (example)
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMED CT Body Structures (example)
... treatment 0..*BackboneElementTreatment 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 S0..1CodeableConceptIndicates the treatment or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example)
.... additive 0..*Reference(Profile qicore-substance)Material used in the processing step
.... time[x] 0..1dateTime, PeriodDate and time of specimen treatment
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringxml:id (or equivalent in JSON)
.... specimen-sequenceNumber I0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..*IdentifierId 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(Profile qicore-substance)Additive associated with container
Binding: v2 Additive/Preservative (example)
... note 0..*AnnotationComments

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*Sample for analysis
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierExternal Identifier
... accessionIdentifier ∑0..1IdentifierIdentifier assigned by the lab
... status ?!∑0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type S0..1CodeableConceptKind of material that forms the specimen
Binding: v2 Specimen Type (example)
... subject S1..1Reference(Profile qicore-patient | Profile qicore-device | Profile qicore-substance | Group)Where the specimen came from. This may be from the patient(s) or from the environment or a device
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Profile qicore-specimen)Specimen from which this specimen originated
... request 0..*Reference(DiagnosticRequest | ProcedureRequest)Why the specimen was collected
... collection 0..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(Profile qicore-practitioner)A person with a formal responsibility in the provisioning of healthcare or related services
.... collected[x] S0..1dateTime, PeriodCollection time
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: SpecimenCollectionMethod (example)
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMED CT Body Structures (example)
... treatment 0..*BackboneElementTreatment 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 S0..1CodeableConceptIndicates the treatment or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example)
.... additive 0..*Reference(Profile qicore-substance)Material used in the processing step
.... time[x] 0..1dateTime, PeriodDate and time of specimen treatment
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringxml:id (or equivalent in JSON)
.... specimen-sequenceNumber I0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..*IdentifierId 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(Profile qicore-substance)Additive associated with container
Binding: v2 Additive/Preservative (example)
... note 0..*AnnotationComments

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Specimen.languageCommon LanguagesextensibleCommon Languages
Specimen.statusSpecimenStatusrequiredSpecimenStatus
Specimen.typev2 Specimen Typeexamplev2 Specimen Type
Specimen.collection.methodSpecimenCollectionMethodexampleSpecimenCollectionMethod
Specimen.collection.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Specimen.treatment.procedureSpecimenTreatmentProcedureexampleSpecimenTreatmentProcedure
Specimen.container.typeSpecimenContainerexampleSpecimenContainer
Specimen.container.additive[x]v2 Additive/Preservativeexamplev2 Additive/Preservative

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2SpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1SpecimenIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4SpecimenIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3SpecimenIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1Specimen.container.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Specimen.container.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.