WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build

This is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.

Resource Profile: DDCC Specimen

Defining URL:http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCSpecimen
Version:1.0.0
Name:DDCCSpecimen
Title:DDCC Specimen
Status:Active as of 2022-11-23 03:17:18+0000
Definition:

A DDCC Specimen contains the content corresponding to a row in the Test Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Specimen resouce, this is intended to map into an IPS Specimen resource.

Publisher:WHO
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCSpecimen

Formal Views of Profile Content

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

This structure is derived from SpecimenUvIps

Summary

Mandatory: 4 elements
Must-Support: 1 element

Slices

This structure defines the following Slices:

  • The element Specimen.collection.collected[x] is sliced based on the value of type:$this

This structure is derived from SpecimenUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenUvIpsSample for analysis
... type 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: WHO Speciman Sample Origin (COVID-19) (required)
... subject 1..1Reference(Patient (IPS))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
... collection 1..1BackboneElementCollection details
.... collected[x] 1..1dateTimeCollection time
Slice: Unordered, Open by type:$this
.... collectedDateTime S1..1dateTimeCollection time

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen S0..*SpecimenUvIpsSample for analysis
... 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
... text 0..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): Codes providing the status/availability of a specimen.

... type S1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: WHO Speciman Sample Origin (COVID-19) (required)
... subject SΣ1..1Reference(Patient (IPS))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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... receivedTime Σ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 S1..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
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime SΣ1..1dateTimeCollection time
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Specimen Collection Method (GPS) - IPS (extensible)
.... bodySite S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (extensible)
.... fastingStatus[x] SΣ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(CodeableConceptIPS)
..... 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 0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenUvIpsSample for analysis
... type 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: WHO Speciman Sample Origin (COVID-19) (required)
... subject Σ1..1Reference(Patient (IPS))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
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... collection 1..1BackboneElementCollection details
.... collected[x]:collectedDateTime Σ1..1dateTimeCollection time
.... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Specimen Collection Method (GPS) - IPS (extensible)
.... bodySite 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (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(CodeableConceptIPS)
..... fastingStatusDurationDuration

doco Documentation for this format

This structure is derived from SpecimenUvIps

Summary

Mandatory: 4 elements
Must-Support: 1 element

Slices

This structure defines the following Slices:

  • The element Specimen.collection.collected[x] is sliced based on the value of type:$this

Differential View

This structure is derived from SpecimenUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenUvIpsSample for analysis
... type 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: WHO Speciman Sample Origin (COVID-19) (required)
... subject 1..1Reference(Patient (IPS))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
... collection 1..1BackboneElementCollection details
.... collected[x] 1..1dateTimeCollection time
Slice: Unordered, Open by type:$this
.... collectedDateTime S1..1dateTimeCollection time

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen S0..*SpecimenUvIpsSample for analysis
... 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
... text 0..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): Codes providing the status/availability of a specimen.

... type S1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: WHO Speciman Sample Origin (COVID-19) (required)
... subject SΣ1..1Reference(Patient (IPS))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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... receivedTime Σ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 S1..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
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime SΣ1..1dateTimeCollection time
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Specimen Collection Method (GPS) - IPS (extensible)
.... bodySite S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (extensible)
.... fastingStatus[x] SΣ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(CodeableConceptIPS)
..... 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 0..*AnnotationComments

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Specimen.statusrequiredSpecimenStatus
Specimen.typerequiredWHO_DDCC_Sample_Origin_COVID_19
Specimen.subject.typeextensibleResourceType
Specimen.collection.methodextensibleResultsSpecimenCollectionMethodGpsUvIps
Specimen.collection.bodySiteextensibleSNOMEDCTBodyStructures
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

Constraints

IdGradePath(s)DetailsRequirements
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()