At-Home In-Vitro Test Report
1.0.0-ballot - Ballot US

This page is part of the At-Home In-Vitro Test Report (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Specimen - At-Home In-Vitro Test - COVID-19

Official URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Specimen-at-home-in-vitro-test-covid Version: 1.0.0-ballot
Active as of 2022-08-08 Computable Name: SpecimenAtHomeInVitroTestCovid

This Specimen profile identifies and describes the specimen used in a COVID-19 At-Home In-Vitro Test.

This is an example of a profile that is based on a framework profile and futher constrained to meet the requirements of the COVID-19 use case. It is based on the Specimen - At-Home In-Vitro Test profile.

It constrains the following element to a COVID-19 specific value set:

  • Specimen.type - ValueSet - At-Home In-Vitro Test Specimen Types - COVID-19

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

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

This structure is derived from SpecimenAtHomeInVitroTest

Summary

Mandatory: 2 elements
Must-Support: 2 elements

This structure is derived from SpecimenAtHomeInVitroTest

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenAtHomeInVitroTestThe specimen used in a COVID-19 at-home lab test.
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierSystem-generated identifier for this Specimen.
... 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Σ1..1CodeableConceptType of tissue or material
Binding: ValueSet - At-Home In-Vitro Test Specimen Types - COVID-19 (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..1CodingThe coded specimen type.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringThe specimen text description.
... subject SΣ0..1Reference(US Core Patient Profile)The subject is the person who took the at-home test.
... 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
.... collected[x] SΣ1..1dateTimeCollection time
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..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 0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... 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 0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenAtHomeInVitroTestThe specimen used in a COVID-19 at-home lab test.
... identifier Σ0..*IdentifierSystem-generated identifier for this Specimen.
... type Σ1..1CodeableConceptType of tissue or material
Binding: ValueSet - At-Home In-Vitro Test Specimen Types - COVID-19 (extensible)
.... coding Σ1..1CodingThe coded specimen type.
..... system Σ1..1uriIdentity of the terminology system
..... code Σ1..1codeSymbol in syntax defined by the system
.... text Σ0..1stringThe specimen text description.
... subject Σ0..1Reference(US Core Patient Profile)The subject is the person who took the at-home test.
.... collected[x] Σ1..1dateTimeCollection time

doco Documentation for this format

This structure is derived from SpecimenAtHomeInVitroTest

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Differential View

This structure is derived from SpecimenAtHomeInVitroTest

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenAtHomeInVitroTestThe specimen used in a COVID-19 at-home lab test.
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierSystem-generated identifier for this Specimen.
... 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Σ1..1CodeableConceptType of tissue or material
Binding: ValueSet - At-Home In-Vitro Test Specimen Types - COVID-19 (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..1CodingThe coded specimen type.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringThe specimen text description.
... subject SΣ0..1Reference(US Core Patient Profile)The subject is the person who took the at-home test.
... 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
.... collected[x] SΣ1..1dateTimeCollection time
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..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 0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... 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 0..*AnnotationComments

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Max Binding: AllLanguages
Specimen.statusrequiredSpecimenStatus
Specimen.typeextensibleValueSetAtHomeInVitroTestSpecimenTypesCovid
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
Specimen.collection.bodySiteexampleSNOMEDCTBodyStructures
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.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.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.type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.type.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.type.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorSpecimen.type.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorSpecimen.type.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.type.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.type.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.type.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.type.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorSpecimen.type.textAll 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())