This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: USLabSpec

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/spec-uslab-uslabspec

USLab Specimen Resource

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.

Formal Views of Profile Content

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

This structure is derived from Specimen.

Summary

Terminology Bindings

  • Specimen.type SHALL come from Codes to describe the Specimen (Extensible)
  • Specimen.collection.bodySiteCodeableConcept SHALL come from Codes to describe the Specimen Collection Body site (Extensible)

Required/Prohibited Elements

  • The element Specimen.identifier.use is required
  • The element Specimen.identifier.system is required
  • The element Specimen.identifier.value is required
  • The element Specimen.type is required
  • The element Specimen.type.coding is required
  • The element Specimen.type.coding.system is required
  • The element Specimen.type.coding.code is required
  • The element Specimen.subject is required
  • The element Specimen.accessionIdentifier is required
  • The element Specimen.accessionIdentifier.use is required
  • The element Specimen.accessionIdentifier.system is required
  • The element Specimen.accessionIdentifier.value is required
  • The element Specimen.collection is required
  • The element Specimen.collection.collected[x] is required
  • The element Specimen.collection.bodySiteCodeableConcept.coding is required
  • The element Specimen.collection.bodySiteCodeableConcept.coding.system is required
  • The element Specimen.collection.bodySiteCodeableConcept.coding.code is required

Fixed Values

  • The element Specimen.identifier.use value has been fixed to official
  • The element Specimen.accessionIdentifier.use value has been fixed to official

This structure is derived from Specimen.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1SpecimenUSLab Specimen Resource
... identifier S0..*
.... use S1..1codeFixed Value: official
.... system S1..1Placer URI
.... value S1..1Placer Identifier
... type S1..1Binding: USLabSpecimenType (extensible)
.... coding S1..*
..... system S1..1
..... code S1..1
..... display S0..1
.... text S0..1Display text
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S1..1
.... use S1..1codeFixed Value: official
.... system S1..1Filler URI
.... value S1..1Filler Identifier
... collection S1..1
.... collected[x] S I1..1inv-2: Datetime must be at least to the day.
.... bodySiteCodeableConcept S0..1CodeableConceptBinding: USLabSpecimenbodySite (extensible)
..... coding S1..*
...... system S1..1
...... code S1..1
...... display S0..1
..... text S0..1Display text
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1SpecimenUSLab Specimen Resource
... 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: Language (required)
... 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 S Σ0..*IdentifierExternal Identifier
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... label 0..1stringDescription of identifier
.... system S1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringPlacer Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... type S Σ1..1CodeableConceptKind of material that forms the specimen
Binding: USLabSpecimenType (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display S0..1stringRepresentation defined by the system
..... primary 0..1booleanIf this code was chosen directly by the user
.... text S0..1stringDisplay text
... parent 0..*SpecimenSpecimen from which this specimen originated
... subject S Σ1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S Σ1..1IdentifierIdentifier assigned by the lab
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... label 0..1stringDescription of identifier
.... system S1..1uriFiller URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringFiller Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... collection S1..1Collection details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... collector Σ0..1PractitionerWho collected the specimen
.... comment 0..*stringCollector comments
.... collected[x] S ΣI1..1dateTime, PeriodCollection time
inv-2: Datetime must be at least to the day.
.... quantity 0..1QuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: SpecimenCollectionMethod (example)
.... bodySiteCodeableConcept S0..1CodeableConceptAnatomical collection site
Binding: USLabSpecimenbodySite (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriIdentity of the terminology system
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSymbol in syntax defined by the system
...... display S0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
..... text S0..1stringDisplay text
... treatment 0..*Treatment and processing step details
.... 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 or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example)
.... additive 0..*SubstanceMaterial used in the processing step
... container 0..*Direct container of specimen (tube/slide, etc)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... 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: SpecimenContainerType (example)
.... capacity 0..1QuantityContainer volume or size
.... specimenQuantity 0..1QuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, SubstanceAdditive associated with container
Binding: SpecimenContainerAdditive (example)

todo

This structure is derived from Specimen.

Summary

Terminology Bindings

  • Specimen.type SHALL come from Codes to describe the Specimen (Extensible)
  • Specimen.collection.bodySiteCodeableConcept SHALL come from Codes to describe the Specimen Collection Body site (Extensible)

Required/Prohibited Elements

  • The element Specimen.identifier.use is required
  • The element Specimen.identifier.system is required
  • The element Specimen.identifier.value is required
  • The element Specimen.type is required
  • The element Specimen.type.coding is required
  • The element Specimen.type.coding.system is required
  • The element Specimen.type.coding.code is required
  • The element Specimen.subject is required
  • The element Specimen.accessionIdentifier is required
  • The element Specimen.accessionIdentifier.use is required
  • The element Specimen.accessionIdentifier.system is required
  • The element Specimen.accessionIdentifier.value is required
  • The element Specimen.collection is required
  • The element Specimen.collection.collected[x] is required
  • The element Specimen.collection.bodySiteCodeableConcept.coding is required
  • The element Specimen.collection.bodySiteCodeableConcept.coding.system is required
  • The element Specimen.collection.bodySiteCodeableConcept.coding.code is required

Fixed Values

  • The element Specimen.identifier.use value has been fixed to official
  • The element Specimen.accessionIdentifier.use value has been fixed to official

Differential View

This structure is derived from Specimen.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1SpecimenUSLab Specimen Resource
... identifier S0..*
.... use S1..1codeFixed Value: official
.... system S1..1Placer URI
.... value S1..1Placer Identifier
... type S1..1Binding: USLabSpecimenType (extensible)
.... coding S1..*
..... system S1..1
..... code S1..1
..... display S0..1
.... text S0..1Display text
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S1..1
.... use S1..1codeFixed Value: official
.... system S1..1Filler URI
.... value S1..1Filler Identifier
... collection S1..1
.... collected[x] S I1..1inv-2: Datetime must be at least to the day.
.... bodySiteCodeableConcept S0..1CodeableConceptBinding: USLabSpecimenbodySite (extensible)
..... coding S1..*
...... system S1..1
...... code S1..1
...... display S0..1
..... text S0..1Display text

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1SpecimenUSLab Specimen Resource
... 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: Language (required)
... 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 S Σ0..*IdentifierExternal Identifier
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... label 0..1stringDescription of identifier
.... system S1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringPlacer Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... type S Σ1..1CodeableConceptKind of material that forms the specimen
Binding: USLabSpecimenType (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display S0..1stringRepresentation defined by the system
..... primary 0..1booleanIf this code was chosen directly by the user
.... text S0..1stringDisplay text
... parent 0..*SpecimenSpecimen from which this specimen originated
... subject S Σ1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S Σ1..1IdentifierIdentifier assigned by the lab
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... label 0..1stringDescription of identifier
.... system S1..1uriFiller URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringFiller Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... collection S1..1Collection details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... collector Σ0..1PractitionerWho collected the specimen
.... comment 0..*stringCollector comments
.... collected[x] S ΣI1..1dateTime, PeriodCollection time
inv-2: Datetime must be at least to the day.
.... quantity 0..1QuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: SpecimenCollectionMethod (example)
.... bodySiteCodeableConcept S0..1CodeableConceptAnatomical collection site
Binding: USLabSpecimenbodySite (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriIdentity of the terminology system
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSymbol in syntax defined by the system
...... display S0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
..... text S0..1stringDisplay text
... treatment 0..*Treatment and processing step details
.... 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 or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example)
.... additive 0..*SubstanceMaterial used in the processing step
... container 0..*Direct container of specimen (tube/slide, etc)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... 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: SpecimenContainerType (example)
.... capacity 0..1QuantityContainer volume or size
.... specimenQuantity 0..1QuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, SubstanceAdditive associated with container
Binding: SpecimenContainerAdditive (example)

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
Specimen.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Specimen.identifier.useIdentifierUserequiredIdentifierUse
Specimen.typeUSLabSpecimenTypeextensibleUSLab Specimen Type
Specimen.accessionIdentifier.useIdentifierUserequiredIdentifierUse
Specimen.collection.methodSpecimenCollectionMethodexampleSpecimenCollectionMethod
Specimen.collection.bodySiteCodeableConceptUSLabSpecimenbodySiteextensibleUSLab Specimen Body Site
Specimen.treatment.procedureSpecimenTreatmentProcedureexampleSpecimenTreatmentProcedure
Specimen.container.typeSpecimenContainerTypeexampleSpecimenContainer
Specimen.container.additive[x]SpecimenContainerAdditiveexamplev2 Additive/Preservative

Constraints

IdPathNameDetails
inv-2Specimen.collection.collected[x]datetime to dayDatetime must be at least to the day.
XPath: f:matches(.,/\d{4}-[01]\d-[0-3])/)
.