IPS Specimen Collection - International Patient Summary (IPS) v1.1.0-ballot

International Patient Summary (IPS)
1.1.0-ballot - CI Build

International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions

Logical Model: IPS Specimen Collection

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.30--20240804210307				Version: 1.1.0-ballot
Draft as of 2024-08-04				Computable Name: IPSSpecimenCollection
Other Identifiers: OID:2.16.840.1.113883.10.22.4.30 (use: official, )

Specimen Collection is used when a set of laboratory or pathology observations produced on one or more specimens need to be associated with the minimal characteristics of the specimen(s): specimen source site and type of specimen. In addition this template enables to convey when the specimen was collected.
In a patient summary there is no need to provide more data than these 4:

collection method,
source site,
type of specimen and
time of collection.

An occurrence of this template describes one specimen collected, used by the set of observations present in the same Result Organizer.

Usage:

This Logical Model is not used by any profiles in this Implementation Guide

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 Procedure

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	Procedure	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:primary	S	1..1	II
@root		1..1	string	Fixed Value: 2.16.840.1.113883.10.22.4.30
@classCode		1..1	code	Fixed Value: PROC
@moodCode		1..1	code	Fixed Value: EVN
code	S	0..1	CD
@code		0..1	cs	Fixed Value: 33882-2
@codeSystem		0..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.6.1
effectiveTime	S	0..1	IVL_TS
methodCode	S	0..1	CE	Binding: IPS Results Specimen Collection Method (required): IPS Results Specimen Collection Method
targetSiteCode	S	0..1	CD	Binding: IPS Body Site (required): IPS Body Site
participant	S	0..1	Participant2
@typeCode		1..1	code	Fixed Value: PRD
participantRole	S	1..1	ParticipantRole
@classCode		0..1	code	Fixed Value: SPEC
id	S	0..1	II
playingEntity	S	1..1	PlayingEntity
@classCode		0..1	code	Fixed Value: ENT
@determinerCode		0..1	code	Fixed Value: INSTANCE
code	S	1..1	CE	Binding: IPS Specimen Type (preferred): IPS Specimen Type
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Procedure.methodCode	required	IPSResultsSpecimenCollectionMethod `http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320` from this IG
Procedure.targetSiteCode	required	IPSTargetSiteCode `http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips` from this IG
Procedure.participant.participantRole.playingEntity.code	preferred	IPS_SpecimenType `http://hl7.org/uv/ips/fhir/ValueSet/specimen-type` from this IG

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	Procedure	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:primary	S	1..1	II
@root		1..1	string	Fixed Value: 2.16.840.1.113883.10.22.4.30
@classCode		1..1	code	Binding: ActClassProcedure (required) Fixed Value: PROC
@moodCode		1..1	code	Binding: x_DocumentProcedureMood (required) Fixed Value: EVN
code	S	0..1	CD
@code		0..1	cs	Fixed Value: 33882-2
@codeSystem		0..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.6.1
effectiveTime	S	0..1	IVL_TS
methodCode	S	0..1	CE	Binding: IPS Results Specimen Collection Method (required): IPS Results Specimen Collection Method
targetSiteCode	S	0..1	CD	Binding: IPS Body Site (required): IPS Body Site
participant	S	0..1	Participant2
@typeCode		1..1	code	Binding: CDAParticipationType (required) Fixed Value: PRD
participantRole	S	1..1	ParticipantRole
@classCode		0..1	code	Binding: CDARoleClassRoot (required) Fixed Value: SPEC
id	S	0..1	II
playingEntity	S	1..1	PlayingEntity
@classCode		0..1	code	Binding: EntityClassRoot (required) Fixed Value: ENT
@determinerCode		0..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: IPS Specimen Type (preferred): IPS Specimen Type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Procedure.classCode	required	Fixed Value: PROC `http://terminology.hl7.org/ValueSet/v3-ActClassProcedure`
Procedure.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood`
Procedure.methodCode	required	IPSResultsSpecimenCollectionMethod `http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320` from this IG
Procedure.targetSiteCode	required	IPSTargetSiteCode `http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips` from this IG
Procedure.participant.typeCode	required	Fixed Value: PRD `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Procedure.participant.participantRole.classCode	required	Fixed Value: SPEC `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Procedure.participant.participantRole.playingEntity.classCode	required	Fixed Value: ENT `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Procedure.participant.participantRole.playingEntity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Procedure.participant.participantRole.playingEntity.code	preferred	IPS_SpecimenType `http://hl7.org/uv/ips/fhir/ValueSet/specimen-type` from this IG

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	Procedure	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 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		0..1	II
@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
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:primary	S	1..1	II
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	string	Fixed Value: 2.16.840.1.113883.10.22.4.30
@extension		0..1	st
@classCode		1..1	code	Binding: ActClassProcedure (required) Fixed Value: PROC
@moodCode		1..1	code	Binding: x_DocumentProcedureMood (required) Fixed Value: EVN
id		0..*	II
code	S	0..1	CD
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		0..1	cs	Fixed Value: 33882-2
@codeSystem		0..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.6.1
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
@sdtcValueSet		0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText		0..1	ED
qualifier		0..*	CR
translation		0..*	CD
@negationInd		0..1	bl
text		0..1	ED
statusCode		0..1	CS	Binding: ActStatus (required)
effectiveTime	S	0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
languageCode		0..1	CS	Binding: AllLanguages (required)
methodCode	S	0..1	CE	Binding: IPS Results Specimen Collection Method (required): IPS Results Specimen Collection Method
approachSiteCode		0..*	CD
targetSiteCode	S	0..1	CD	Binding: IPS Body Site (required): IPS Body Site
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant	S	0..1	Participant2
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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		1..1	code	Binding: CDAParticipationType (required) Fixed Value: PRD
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
sdtcFunctionCode		0..1	CE	XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc)
time		0..1	IVL_TS
awarenessCode		0..1	CE
participantRole	S	1..1	ParticipantRole
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
@classCode		0..1	code	Binding: CDARoleClassRoot (required) Fixed Value: SPEC
id	S	0..1	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
playingDevice		0..1	Device
playingEntity	S	1..1	PlayingEntity
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
@classCode		0..1	code	Binding: EntityClassRoot (required) Fixed Value: ENT
@determinerCode		0..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: IPS Specimen Type (preferred): IPS Specimen Type
quantity		0..*	PQ
name		0..*	PN
sdtcBirthTime		0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc)
desc		0..1	ED
scopingEntity		0..1	Entity
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Procedure.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.templateId:primary.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.classCode	required	Fixed Value: PROC `http://terminology.hl7.org/ValueSet/v3-ActClassProcedure`
Procedure.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood`
Procedure.code.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Procedure.priorityCode	example	ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Procedure.languageCode	required	AllLanguages `http://hl7.org/fhir/ValueSet/all-languages`
Procedure.methodCode	required	IPSResultsSpecimenCollectionMethod `http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320` from this IG
Procedure.targetSiteCode	required	IPSTargetSiteCode `http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips` from this IG
Procedure.participant.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.typeCode	required	Fixed Value: PRD `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Procedure.participant.contextControlCode	required	Fixed Value: OP `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl`
Procedure.participant.participantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.classCode	required	Fixed Value: SPEC `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Procedure.participant.participantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode`
Procedure.participant.participantRole.playingEntity.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.playingEntity.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.playingEntity.classCode	required	Fixed Value: ENT `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Procedure.participant.participantRole.playingEntity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Procedure.participant.participantRole.playingEntity.code	preferred	IPS_SpecimenType `http://hl7.org/uv/ips/fhir/ValueSet/specimen-type` from this IG

This structure is derived from Procedure

Summary

Mandatory: 5 elements(4 nested mandatory elements)
Must-Support: 10 elements
Fixed: 9 elements

Slices

This structure defines the following Slices:

The element 2 is sliced based on the values of Procedure.templateId

Differential View

This structure is derived from Procedure

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	Procedure	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:primary	S	1..1	II
@root		1..1	string	Fixed Value: 2.16.840.1.113883.10.22.4.30
@classCode		1..1	code	Fixed Value: PROC
@moodCode		1..1	code	Fixed Value: EVN
code	S	0..1	CD
@code		0..1	cs	Fixed Value: 33882-2
@codeSystem		0..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.6.1
effectiveTime	S	0..1	IVL_TS
methodCode	S	0..1	CE	Binding: IPS Results Specimen Collection Method (required): IPS Results Specimen Collection Method
targetSiteCode	S	0..1	CD	Binding: IPS Body Site (required): IPS Body Site
participant	S	0..1	Participant2
@typeCode		1..1	code	Fixed Value: PRD
participantRole	S	1..1	ParticipantRole
@classCode		0..1	code	Fixed Value: SPEC
id	S	0..1	II
playingEntity	S	1..1	PlayingEntity
@classCode		0..1	code	Fixed Value: ENT
@determinerCode		0..1	code	Fixed Value: INSTANCE
code	S	1..1	CE	Binding: IPS Specimen Type (preferred): IPS Specimen Type
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Procedure.methodCode	required	IPSResultsSpecimenCollectionMethod `http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320` from this IG
Procedure.targetSiteCode	required	IPSTargetSiteCode `http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips` from this IG
Procedure.participant.participantRole.playingEntity.code	preferred	IPS_SpecimenType `http://hl7.org/uv/ips/fhir/ValueSet/specimen-type` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	Procedure	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:primary	S	1..1	II
@root		1..1	string	Fixed Value: 2.16.840.1.113883.10.22.4.30
@classCode		1..1	code	Binding: ActClassProcedure (required) Fixed Value: PROC
@moodCode		1..1	code	Binding: x_DocumentProcedureMood (required) Fixed Value: EVN
code	S	0..1	CD
@code		0..1	cs	Fixed Value: 33882-2
@codeSystem		0..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.6.1
effectiveTime	S	0..1	IVL_TS
methodCode	S	0..1	CE	Binding: IPS Results Specimen Collection Method (required): IPS Results Specimen Collection Method
targetSiteCode	S	0..1	CD	Binding: IPS Body Site (required): IPS Body Site
participant	S	0..1	Participant2
@typeCode		1..1	code	Binding: CDAParticipationType (required) Fixed Value: PRD
participantRole	S	1..1	ParticipantRole
@classCode		0..1	code	Binding: CDARoleClassRoot (required) Fixed Value: SPEC
id	S	0..1	II
playingEntity	S	1..1	PlayingEntity
@classCode		0..1	code	Binding: EntityClassRoot (required) Fixed Value: ENT
@determinerCode		0..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: IPS Specimen Type (preferred): IPS Specimen Type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Procedure.classCode	required	Fixed Value: PROC `http://terminology.hl7.org/ValueSet/v3-ActClassProcedure`
Procedure.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood`
Procedure.methodCode	required	IPSResultsSpecimenCollectionMethod `http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320` from this IG
Procedure.targetSiteCode	required	IPSTargetSiteCode `http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips` from this IG
Procedure.participant.typeCode	required	Fixed Value: PRD `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Procedure.participant.participantRole.classCode	required	Fixed Value: SPEC `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Procedure.participant.participantRole.playingEntity.classCode	required	Fixed Value: ENT `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Procedure.participant.participantRole.playingEntity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Procedure.participant.participantRole.playingEntity.code	preferred	IPS_SpecimenType `http://hl7.org/uv/ips/fhir/ValueSet/specimen-type` from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	Procedure	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 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		0..1	II
@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
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:primary	S	1..1	II
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	string	Fixed Value: 2.16.840.1.113883.10.22.4.30
@extension		0..1	st
@classCode		1..1	code	Binding: ActClassProcedure (required) Fixed Value: PROC
@moodCode		1..1	code	Binding: x_DocumentProcedureMood (required) Fixed Value: EVN
id		0..*	II
code	S	0..1	CD
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		0..1	cs	Fixed Value: 33882-2
@codeSystem		0..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.6.1
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
@sdtcValueSet		0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText		0..1	ED
qualifier		0..*	CR
translation		0..*	CD
@negationInd		0..1	bl
text		0..1	ED
statusCode		0..1	CS	Binding: ActStatus (required)
effectiveTime	S	0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
languageCode		0..1	CS	Binding: AllLanguages (required)
methodCode	S	0..1	CE	Binding: IPS Results Specimen Collection Method (required): IPS Results Specimen Collection Method
approachSiteCode		0..*	CD
targetSiteCode	S	0..1	CD	Binding: IPS Body Site (required): IPS Body Site
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant	S	0..1	Participant2
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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		1..1	code	Binding: CDAParticipationType (required) Fixed Value: PRD
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
sdtcFunctionCode		0..1	CE	XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc)
time		0..1	IVL_TS
awarenessCode		0..1	CE
participantRole	S	1..1	ParticipantRole
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
@classCode		0..1	code	Binding: CDARoleClassRoot (required) Fixed Value: SPEC
id	S	0..1	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
playingDevice		0..1	Device
playingEntity	S	1..1	PlayingEntity
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
@classCode		0..1	code	Binding: EntityClassRoot (required) Fixed Value: ENT
@determinerCode		0..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: IPS Specimen Type (preferred): IPS Specimen Type
quantity		0..*	PQ
name		0..*	PN
sdtcBirthTime		0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc)
desc		0..1	ED
scopingEntity		0..1	Entity
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Procedure.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.templateId:primary.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.classCode	required	Fixed Value: PROC `http://terminology.hl7.org/ValueSet/v3-ActClassProcedure`
Procedure.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood`
Procedure.code.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Procedure.priorityCode	example	ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Procedure.languageCode	required	AllLanguages `http://hl7.org/fhir/ValueSet/all-languages`
Procedure.methodCode	required	IPSResultsSpecimenCollectionMethod `http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320` from this IG
Procedure.targetSiteCode	required	IPSTargetSiteCode `http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips` from this IG
Procedure.participant.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.typeCode	required	Fixed Value: PRD `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Procedure.participant.contextControlCode	required	Fixed Value: OP `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl`
Procedure.participant.participantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.classCode	required	Fixed Value: SPEC `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Procedure.participant.participantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode`
Procedure.participant.participantRole.playingEntity.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.playingEntity.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Procedure.participant.participantRole.playingEntity.classCode	required	Fixed Value: ENT `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Procedure.participant.participantRole.playingEntity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Procedure.participant.participantRole.playingEntity.code	preferred	IPS_SpecimenType `http://hl7.org/uv/ips/fhir/ValueSet/specimen-type` from this IG

This structure is derived from Procedure

Summary

Mandatory: 5 elements(4 nested mandatory elements)
Must-Support: 10 elements
Fixed: 9 elements

Slices

This structure defines the following Slices:

The element 2 is sliced based on the values of Procedure.templateId

Other representations of profile: CSV, Excel

IG © 2024+ Health Level Seven. Package hl7.cda.uv.ips#1.1.0-ballot based on FHIR 4.0.1. Generated 2024-08-19
Links: Table of Contents | QA Report | Version History external | | Propose a change