Case Based Surveillance Implementation Guide
0.2.1 - ci-build

Case Based Surveillance Implementation Guide - Local Development build (v0.2.1). See the Directory of published versions

Resource Profile: Case Based Surveillance Specimen Profile

Official URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-specimen Version: 0.2.1
Active as of 2021-01-01 Computable Name: CaseBasedSurveillanceSpecimen

This profile sets minimum expectations for the [Specimen] resource to represent data requested as part of the U.S. Public Health Case Based Surveillance messaging guides. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US CBS Patient profile:

  • Represent a specimen tested as part of a diagnostic lab report.

Relationship to CDC Message Mapping Guides

The Center for Disease Control’s (CDC) Message Mapping Guides (MMGs) provide guidance on the transmission of records from jurisdictions to case based surveillance programs. MMG documents are publicly available through the CDC’s website. In addition to generic information captured by the Gen V2 guide, there are program specific guides tied to specific conditions or groups of condition.

The US CBS Condition of Interest profile represents the core reported condition of interest (as defined by the Nationally Notifiable Disease Surveillance System & Other Conditions of Public Health Importance valueset) which is reported in the Gen V2 message mapping guide. It should be considered the resource which determines the recipient case surveillance program which oversees surveillance for the specified condition of interest.

Mandatory and Must Support Data Elements

The following data-elements must always be present (Mandatory definition]) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Specimen must have:

  1. a subject reference

Each Specimen must support:

  1. an extension capturing specimen role
  2. a placer assigned identifier
  3. a filler assigned identifier
  4. a specimen type
  5. a received time for when the specimen was received by the performing laboratory
  6. a collected date time or period
  7. a collected quantity
  8. a collection body site
  9. a note

Formal Views of Profile Content

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

This structure is derived from Specimen

Summary

Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 14 elements

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.identifier is sliced based on the value of pattern:type

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-specimen-role S0..1CodeableConceptCase Based Surveillance Specimen Role Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-specimen-role
Binding: Specimen Role (required): Code for Specimen Role Value Set

... Slices for identifier 0..*IdentifierExternal Identifier
Slice: Unordered, Open by pattern:type
.... identifier:placerAssignedId S0..1IdentifierExternal Identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... system S0..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
.... identifier:fillerAssignedId S0..1IdentifierExternal Identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... system S0..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
... subject S1..1Reference(US Case Based Surveillance Patient Profile)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... collection
.... collected[x] S0..1dateTime, PeriodCollection time
.... quantity S0..1SimpleQuantityThe quantity of specimen collected
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: Body site (extensible)
... note S0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-specimen-role S0..1CodeableConceptCase Based Surveillance Specimen Role Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-specimen-role
Binding: Specimen Role (required): Code for Specimen Role Value Set


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Identifier
Slice: Unordered, Open by pattern:type
.... identifier:placerAssignedId SΣ0..1IdentifierExternal Identifier
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:fillerAssignedId SΣ0..1IdentifierExternal Identifier
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen (extensible)
... subject SΣ1..1Reference(US Case Based Surveillance Patient Profile)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] SΣ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity S0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: Body site (extensible)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive 0..*Reference(Substance)Material used in the processing step
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note S0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... cbs-specimen-role 0..1CodeableConceptCase Based Surveillance Specimen Role Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-specimen-role
Binding: Specimen Role (required): Code for Specimen Role Value Set


... identifier:placerAssignedId Σ0..1IdentifierExternal Identifier
.... system Σ0..1uriThe namespace for the identifier value
.... value Σ1..1stringThe value that is unique
... identifier:fillerAssignedId Σ0..1IdentifierExternal Identifier
.... system Σ0..1uriThe namespace for the identifier value
.... value Σ1..1stringThe value that is unique
... subject Σ1..1Reference(US Case Based Surveillance Patient Profile)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... collection 0..1BackboneElementCollection details
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: Body site (extensible)
... note 0..*AnnotationComments

doco Documentation for this format

This structure is derived from Specimen

Summary

Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 14 elements

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.identifier is sliced based on the value of pattern:type

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-specimen-role S0..1CodeableConceptCase Based Surveillance Specimen Role Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-specimen-role
Binding: Specimen Role (required): Code for Specimen Role Value Set

... Slices for identifier 0..*IdentifierExternal Identifier
Slice: Unordered, Open by pattern:type
.... identifier:placerAssignedId S0..1IdentifierExternal Identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... system S0..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
.... identifier:fillerAssignedId S0..1IdentifierExternal Identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... system S0..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
... subject S1..1Reference(US Case Based Surveillance Patient Profile)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... collection
.... collected[x] S0..1dateTime, PeriodCollection time
.... quantity S0..1SimpleQuantityThe quantity of specimen collected
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: Body site (extensible)
... note S0..*AnnotationComments

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-specimen-role S0..1CodeableConceptCase Based Surveillance Specimen Role Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-specimen-role
Binding: Specimen Role (required): Code for Specimen Role Value Set


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Identifier
Slice: Unordered, Open by pattern:type
.... identifier:placerAssignedId SΣ0..1IdentifierExternal Identifier
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:fillerAssignedId SΣ0..1IdentifierExternal Identifier
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen (extensible)
... subject SΣ1..1Reference(US Case Based Surveillance Patient Profile)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] SΣ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity S0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: Body site (extensible)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive 0..*Reference(Substance)Material used in the processing step
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note S0..*AnnotationComments

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Specimen.languagepreferredCommonLanguages
Max Binding: AllLanguages
Specimen.identifier:placerAssignedId.userequiredIdentifierUse
Specimen.identifier:placerAssignedId.typerequiredPattern: PLAC
Specimen.identifier:fillerAssignedId.userequiredIdentifierUse
Specimen.identifier:fillerAssignedId.typerequiredPattern: FILL
Specimen.statusrequiredSpecimenStatus
Specimen.typeextensiblePHVS_Specimen_CDC
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
Specimen.collection.bodySiteextensiblePHVS_BodySite_CDC
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

Constraints

IdGradePathDetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSpecimenIf 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-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeSpecimenA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorSpecimen.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.extension:specimen-roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.extension:specimen-roleMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:placerAssignedIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:placerAssignedId.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.identifier:placerAssignedId.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.identifier:placerAssignedId.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:placerAssignedId.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:placerAssignedId.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:placerAssignedId.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:placerAssignedId.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:placerAssignedId.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:fillerAssignedIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:fillerAssignedId.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.identifier:fillerAssignedId.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.identifier:fillerAssignedId.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:fillerAssignedId.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:fillerAssignedId.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:fillerAssignedId.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:fillerAssignedId.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.identifier:fillerAssignedId.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.accessionIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.receivedTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.parentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collectionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.collection.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.collection.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.collection.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.collection.collectorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.collected[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.durationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.quantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.collection.fastingStatus[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.processing.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.processing.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.processing.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.processing.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.procedureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.additiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.processing.time[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.containerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.container.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.container.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.container.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.container.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.capacityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.specimenQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.container.additive[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())