2nd DSTU Draft For Comment

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

Profile: USLabSpec

The official URL for this profile is: 

http://hl7.org/fhir/Profile/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.

Summary

Terminology Bindings

  • Specimen.type.coding must come from Codes to describe the Specimen
  • Specimen.collection.bodySiteCodeableConcept.coding must come from Codes to describe the Specimen Collection Body site

Required/Prohibited Elements

  • The element Specimen is required
  • The element Specimen.identifier.use is required
  • The element Specimen.identifier.label 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.system is required
  • The element Specimen.type.coding.code 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.system is required
  • The element Specimen.collection.bodySiteCodeableConcept.coding.code 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.identifier.label value has been fixed to Placer Specimen ID
  • The element Specimen.type.coding.system value has been fixed to http://snomed.info/sct
  • The element Specimen.accessionIdentifier.use value has been fixed to official
  • The element Specimen.collection.bodySiteCodeableConcept.coding.system value has been fixed to http://snomed.info/sct

Formal Views of Profile Content

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

Differential View

This structure is derived from Specimen.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1USLab Specimen Resource
... identifier Slice: Ordered, Open At End, by identifier.label
... identifier S0..1
.... use S1..1codeFixed Value: official
.... label S1..1stringFixed Value: Placer Specimen ID
.... system S1..1Placer URI
.... value S1..1Placer Identifier
... type S1..1
.... coding Slice: Unordered, Open, by system
.... coding S0..1SNOMED-CT coding if available
Binding: USLabSpecimenType (required, extensible)
..... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
..... code S1..1SNOMED-CT
..... display S0..1SNOMED-CT Display Name
.... coding S0..1
..... system S1..1uriLocal Coding System
..... code S1..1Local Code
..... display S0..1local Code Display name
.... text S0..1Display text
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S1..1Identifier
.... 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..1CodeableConcept
..... coding Slice: Unordered, Open, by system
..... coding S0..1SNOMED-CT coding if available
Binding: USLabSpecimenbodySite[x] (required, extensible)
...... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
...... code S1..1SNOMED-CT
...... display S0..1SNOMED-CT Display Name
..... coding S0..1
...... system S1..1uriLocal Coding System
...... code S1..1Local Code
...... display S0..1local Code Display name
..... text S0..1Display text

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1USLab Specimen Resource
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not 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 IdentifierExternal Identifier
Slice: Ordered, Open At End, by identifier.label
... identifier S0..1IdentifierExternal Identifier
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
Fixed Value: official
.... label S1..1stringDescription of identifier
Fixed Value: Placer Specimen ID
.... 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 S1..1CodeableConceptKind of material that forms the specimen
Binding: SpecimenType (example, extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding CodingCode defined by a terminology system
Slice: Unordered, Open, by system
.... coding S0..1CodingSNOMED-CT coding if available
Binding: USLabSpecimenType (required, extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSNOMED-CT
..... display S0..1stringSNOMED-CT Display Name
..... primary 0..1booleanIf this code was chosen directly by the user
..... valueSet 0..1ValueSetSet this coding was chosen from
.... coding S0..1CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriLocal Coding System
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeLocal Code
..... display S0..1stringlocal Code Display name
..... primary 0..1booleanIf this code was chosen directly by the user
..... valueSet 0..1ValueSetSet this coding was chosen from
.... text S0..1stringDisplay text
... parent 0..*SpecimenParent specimen
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S1..1IdentifierIdentifier assigned by the lab
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
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
.... id 0..1idxml:id (or equivalent in JSON)
.... 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, extensible)
.... bodySiteCodeableConcept S0..1CodeableConceptAnatomical collection site
Binding: BodySite (example, extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding CodingCode defined by a terminology system
Slice: Unordered, Open, by system
..... coding S0..1CodingSNOMED-CT coding if available
Binding: USLabSpecimenbodySite[x] (required, extensible)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSNOMED-CT
...... display S0..1stringSNOMED-CT Display Name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... coding S0..1CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriLocal Coding System
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeLocal Code
...... display S0..1stringlocal Code Display name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... text S0..1stringDisplay text
... treatment 0..*Treatment and processing step details
.... id 0..1idxml: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 or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example, extensible)
.... additive 0..*SubstanceMaterial used in the processing step
... container 0..*Direct container of specimen (tube/slide, etc)
.... id 0..1idxml:id (or equivalent in JSON)
.... 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, extensible)
.... capacity 0..1QuantityContainer volume or size
.... specimenQuantity 0..1QuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, SubstanceAdditive associated with container
Binding: SpecimenContainerAdditive (example, extensible)

XML Template

JSON Template

todo

Differential View

This structure is derived from Specimen.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1USLab Specimen Resource
... identifier Slice: Ordered, Open At End, by identifier.label
... identifier S0..1
.... use S1..1codeFixed Value: official
.... label S1..1stringFixed Value: Placer Specimen ID
.... system S1..1Placer URI
.... value S1..1Placer Identifier
... type S1..1
.... coding Slice: Unordered, Open, by system
.... coding S0..1SNOMED-CT coding if available
Binding: USLabSpecimenType (required, extensible)
..... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
..... code S1..1SNOMED-CT
..... display S0..1SNOMED-CT Display Name
.... coding S0..1
..... system S1..1uriLocal Coding System
..... code S1..1Local Code
..... display S0..1local Code Display name
.... text S0..1Display text
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S1..1Identifier
.... 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..1CodeableConcept
..... coding Slice: Unordered, Open, by system
..... coding S0..1SNOMED-CT coding if available
Binding: USLabSpecimenbodySite[x] (required, extensible)
...... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
...... code S1..1SNOMED-CT
...... display S0..1SNOMED-CT Display Name
..... coding S0..1
...... system S1..1uriLocal Coding System
...... code S1..1Local Code
...... display S0..1local Code Display name
..... text S0..1Display text

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 1..1USLab Specimen Resource
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not 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 IdentifierExternal Identifier
Slice: Ordered, Open At End, by identifier.label
... identifier S0..1IdentifierExternal Identifier
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
Fixed Value: official
.... label S1..1stringDescription of identifier
Fixed Value: Placer Specimen ID
.... 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 S1..1CodeableConceptKind of material that forms the specimen
Binding: SpecimenType (example, extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding CodingCode defined by a terminology system
Slice: Unordered, Open, by system
.... coding S0..1CodingSNOMED-CT coding if available
Binding: USLabSpecimenType (required, extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSNOMED-CT
..... display S0..1stringSNOMED-CT Display Name
..... primary 0..1booleanIf this code was chosen directly by the user
..... valueSet 0..1ValueSetSet this coding was chosen from
.... coding S0..1CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriLocal Coding System
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeLocal Code
..... display S0..1stringlocal Code Display name
..... primary 0..1booleanIf this code was chosen directly by the user
..... valueSet 0..1ValueSetSet this coding was chosen from
.... text S0..1stringDisplay text
... parent 0..*SpecimenParent specimen
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientPatient
... accessionIdentifier S1..1IdentifierIdentifier assigned by the lab
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
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
.... id 0..1idxml:id (or equivalent in JSON)
.... 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, extensible)
.... bodySiteCodeableConcept S0..1CodeableConceptAnatomical collection site
Binding: BodySite (example, extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding CodingCode defined by a terminology system
Slice: Unordered, Open, by system
..... coding S0..1CodingSNOMED-CT coding if available
Binding: USLabSpecimenbodySite[x] (required, extensible)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriSNOMED-CT Coding System
Fixed Value: http://snomed.info/sct
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSNOMED-CT
...... display S0..1stringSNOMED-CT Display Name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... coding S0..1CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriLocal Coding System
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeLocal Code
...... display S0..1stringlocal Code Display name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... text S0..1stringDisplay text
... treatment 0..*Treatment and processing step details
.... id 0..1idxml: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 or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example, extensible)
.... additive 0..*SubstanceMaterial used in the processing step
... container 0..*Direct container of specimen (tube/slide, etc)
.... id 0..1idxml:id (or equivalent in JSON)
.... 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, extensible)
.... capacity 0..1QuantityContainer volume or size
.... specimenQuantity 0..1QuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, SubstanceAdditive associated with container
Binding: SpecimenContainerAdditive (example, extensible)

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Specimen.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Specimen.identifier.useIdentifierUserequiredIdentifierUse
Specimen.typeSpecimenTypeexample (extensible)v2 Specimen Type
Specimen.type.codingUSLabSpecimenTyperequired (extensible)USLabSpecimenType
Specimen.accessionIdentifier.useIdentifierUserequiredIdentifierUse
Specimen.collection.methodSpecimenCollectionMethodexample (extensible)SpecimenCollectionMethod
Specimen.collection.bodySiteCodeableConceptBodySiteexample (extensible)SNOMED CT Body Structures
Specimen.collection.bodySiteCodeableConcept.codingUSLabSpecimenbodySite[x]required (extensible)SNOMED CT Body Structures
Specimen.treatment.procedureSpecimenTreatmentProcedureexample (extensible)SpecimenTreatmentProcedure
Specimen.container.typeSpecimenContainerTypeexample (extensible)SpecimenContainer
Specimen.container.additive[x]SpecimenContainerAdditiveexample (extensible)v2 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])/)
.