HL7中国FHIR Connectathon测试实施指南
2024.5.5 - release

本指南适用于HL7中国的FHIR Connectathon测试。

Resource Profile: 核酸检测样本结构定义

Defining URL:http://hl7.org.cn/fhir/StructureDefinition/profile-covid19-specimen
Version:2024.5.5
Name:Covid19Specimen
Title:核酸检测样本结构定义
Status:Active as of 2024-05-05 21:11:47+0800
Definition:

核酸检测样本资源本地化定义。

Publisher:HL7中国. HL7中国,
Source Resource:XML / JSON / Turtle

本定义的正式URL为: 

http://hl7.org.cn/fhir/StructureDefinition/profile-covid19-specimen

定义内容的视图

关于定义、差异、快照以及如何解读这些表示法。

这种结构源自 Specimen

Summary

Mandatory: 6 elements

Slices

This structure defines the following Slices:

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

这种结构源自 Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen Specimen
... identifier 0..*Identifier样本编号
... status 0..1code核酸检测样本的状态，默认值可以设为available
... type 1..1CodeableConcept样本类型。例如：咽拭子等
Binding: 核酸检测样本类型代码表 (required)
... receivedTime 0..1dateTime接收到样本的时间
... collection 1..1BackboneElement样本采集信息
.... collector 1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)样本采集员
.... collected[x] 1..1dateTimeCollection time
Slice: Unordered, Open by type:$this
.... collectedDateTime 1..1dateTime样本采集时间

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample 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..*Identifier样本编号
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1code核酸检测样本的状态，默认值可以设为available
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type Σ1..1CodeableConcept样本类型。例如：咽拭子等
Binding: 核酸检测样本类型代码表 (required)
... subject Σ1..1Reference(Patient)核酸检测的居民
... receivedTime Σ0..1dateTime接收到样本的时间
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... combined Σ0..1codegrouped | pooled
Binding: SpecimenCombined (required): Codes for the combined status of a specimen.

... role 0..*CodeableConceptThe role the specimen serves
Binding: SpecimenRole (preferred): Codes describing specimen role.


... feature 0..*BackboneElementThe physical feature of a specimen
.... 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
.... type 1..1CodeableConceptHighlighted feature
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts

.... description 1..1stringInformation about the feature
... collection 1..1BackboneElement样本采集信息
.... 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 Σ1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)样本采集员
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime Σ1..1dateTime样本采集时间
.... 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.

.... device 0..1CodeableReference(Device)Device used to perform collection
Binding: (unbound) (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).

.... procedure 0..1Reference(Procedure)The procedure that collects the specimen
.... bodySite 0..1CodeableReference(BodyStructure)Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts

.... 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
.... method 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingMethod (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
.... device 1..1Reference(Device)Device resource for the container
.... location 0..1Reference(Location)Where the container is
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
... 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

这种结构源自 Specimen

Summary

Mandatory: 6 elements

Slices

This structure defines the following Slices:

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

差异视图

这种结构源自 Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen Specimen
... identifier 0..*Identifier样本编号
... status 0..1code核酸检测样本的状态，默认值可以设为available
... type 1..1CodeableConcept样本类型。例如：咽拭子等
Binding: 核酸检测样本类型代码表 (required)
... receivedTime 0..1dateTime接收到样本的时间
... collection 1..1BackboneElement样本采集信息
.... collector 1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)样本采集员
.... collected[x] 1..1dateTimeCollection time
Slice: Unordered, Open by type:$this
.... collectedDateTime 1..1dateTime样本采集时间

doco Documentation for this format

快照视图

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample 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..*Identifier样本编号
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1code核酸检测样本的状态，默认值可以设为available
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type Σ1..1CodeableConcept样本类型。例如：咽拭子等
Binding: 核酸检测样本类型代码表 (required)
... subject Σ1..1Reference(Patient)核酸检测的居民
... receivedTime Σ0..1dateTime接收到样本的时间
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... combined Σ0..1codegrouped | pooled
Binding: SpecimenCombined (required): Codes for the combined status of a specimen.

... role 0..*CodeableConceptThe role the specimen serves
Binding: SpecimenRole (preferred): Codes describing specimen role.


... feature 0..*BackboneElementThe physical feature of a specimen
.... 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
.... type 1..1CodeableConceptHighlighted feature
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts

.... description 1..1stringInformation about the feature
... collection 1..1BackboneElement样本采集信息
.... 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 Σ1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)样本采集员
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime Σ1..1dateTime样本采集时间
.... 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.

.... device 0..1CodeableReference(Device)Device used to perform collection
Binding: (unbound) (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).

.... procedure 0..1Reference(Procedure)The procedure that collects the specimen
.... bodySite 0..1CodeableReference(BodyStructure)Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts

.... 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
.... method 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingMethod (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
.... device 1..1Reference(Device)Device resource for the container
.... location 0..1Reference(Location)Where the container is
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
... 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

 

本定义的其它表示法: Schematron

Terminology Bindings

PathConformanceValueSetURI
Specimen.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|5.0.0
from the FHIR Standard
Specimen.typerequiredCovid19SpecimenTypeCodes
http://hl7.org.cn/fhir/ValueSet/covid19-specimen-type-codes
from this IG
Specimen.combinedrequiredSpecimenCombined
http://hl7.org/fhir/ValueSet/specimen-combined|5.0.0
from the FHIR Standard
Specimen.rolepreferredSpecimenRole
http://hl7.org/fhir/ValueSet/specimen-role
from the FHIR Standard
Specimen.feature.typeexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
http://hl7.org/fhir/ValueSet/specimen-collection-method
from the FHIR Standard
Specimen.collection.deviceexample
Specimen.collection.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.methodexampleSpecimenProcessingMethod
http://hl7.org/fhir/ValueSet/specimen-processing-method
from the FHIR Standard
Specimen.conditionextensibleHl7VSSpecimenCondition
http://terminology.hl7.org/ValueSet/v2-0493

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()