Specimen (CDA Class) - Clinical Document Architecture v2.0.1-sd

Clinical Document Architecture
2.0.1-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: Specimen (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Specimen				Version: 2.0.1-sd
Active as of 2024-12-18				Computable Name: Specimen

A specimen is a part of some entity, typically the subject, that is the target of focused laboratory, radiology or other observations. In many clinical observations, such as physical examination of a patient, the patient is the subject of the observation, and there is no specimen. The specimen participant is only used when observations are made against some substance or object that is taken or derived from the subject.

Usage:

Use this Logical Model Profile: Act (CDA Class), Encounter (CDA Class), Observation (CDA Class), ObservationMedia (CDA Class)... Show 5 more

Formal Views of Template Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
Specimen	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@typeCode	0..1	cs	Binding: CDAParticipationType (required) Fixed Value: SPC
specimenRole	1..1	SpecimenRole
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Specimen.typeCode	required	Fixed Value: SPC `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` from this IG

Name	Flags	Card.	Type	Description & Constraints
Specimen		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@typeCode		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: SPC
specimenRole		1..1	SpecimenRole
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeCode	required	Fixed Value: SPC `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Specimen.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints
Specimen		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@typeCode		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: SPC
specimenRole		1..1	SpecimenRole
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeCode	required	Fixed Value: SPC `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Specimen.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
Specimen	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@typeCode	0..1	cs	Binding: CDAParticipationType (required) Fixed Value: SPC
specimenRole	1..1	SpecimenRole
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Specimen.typeCode	required	Fixed Value: SPC `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Specimen		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@typeCode		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: SPC
specimenRole		1..1	SpecimenRole
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeCode	required	Fixed Value: SPC `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Specimen.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Specimen		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@typeCode		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: SPC
specimenRole		1..1	SpecimenRole
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Specimen.typeCode	required	Fixed Value: SPC `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Specimen.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Other representations of profile: CSV, Excel

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History external | | Propose a change