IPS Medical Device - 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 Medical Device

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.26--20170411000000				Version: 1.1.0-ballot
Draft as of 2017-04-11				Computable Name: IPSMedicalDevice
Other Identifiers: OID:2.16.840.1.113883.10.22.4.26 (use: official, )

The medical devices entry content module describes the kind of device that is, or has been used by the patient

Usage:

Use this Logical Model: IPS Medical Devices Section

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 Supply

Name	Flags	Card.	Type	Description & Constraints
Supply	S	0..*	Supply	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, 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.26
@classCode		1..1	code	Fixed Value: SPLY
@moodCode		1..1	code	Fixed Value: EVN
id	S	0..*	II
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
effectiveTime	S	1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
@type		1..1	string	XML Namespace: http://www.w3.org/2001/XMLSchema-instance XML: xsi (http://www.w3.org/2001/XMLSchema-instance) Fixed Value: IVL_TS
low	S	1..1
high		0..1
participant	S	1..*	Participant2
@typeCode		1..1	code	Fixed Value: DEV
participantRole	S	1..1	ParticipantRole
@classCode		1..1	code	Fixed Value: MANU
id	S	0..*	II
playingDevice	S	1..1	Device
@classCode		1..1	code	Fixed Value: DEV
@determinerCode		1..1	code	Fixed Value: INSTANCE
code	S	1..1	CE	Binding: Absent or Unknown Devices (preferred): Absent or Unknown Devices
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Supply.participant.participantRole.playingDevice.code	preferred	IPSNoDevicesInfos `http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips` from this IG

Name	Flags	Card.	Type	Description & Constraints
Supply	S	0..*	Supply	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, 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.26
@classCode		1..1	code	Binding: ActClassSupply (required) Fixed Value: SPLY
@moodCode		1..1	code	Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN
id	S	0..*	II
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
effectiveTime	S	1..1
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
participant	S	1..*	Participant2
@typeCode		1..1	code	Binding: CDAParticipationType (required) Fixed Value: DEV
participantRole	S	1..1	ParticipantRole
@classCode		1..1	code	Binding: CDARoleClassRoot (required) Fixed Value: MANU
id	S	0..*	II
playingDevice	S	1..1	Device
@classCode		1..1	code	Binding: EntityClassDevice (required) Fixed Value: DEV
@determinerCode		1..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: Absent or Unknown Devices (preferred): Absent or Unknown Devices
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Supply.classCode	required	Fixed Value: SPLY `http://terminology.hl7.org/ValueSet/v3-ActClassSupply`
Supply.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood\|2.0.0`
Supply.participant.typeCode	required	Fixed Value: DEV `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Supply.participant.participantRole.classCode	required	Fixed Value: MANU `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Supply.participant.participantRole.playingDevice.classCode	required	Fixed Value: DEV `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice`
Supply.participant.participantRole.playingDevice.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Supply.participant.participantRole.playingDevice.code	preferred	IPSNoDevicesInfos `http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips` from this IG

Name	Flags	Card.	Type	Description & Constraints
Supply	S	0..*	Supply	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, 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.26
@extension		0..1	st
@classCode		1..1	code	Binding: ActClassSupply (required) Fixed Value: SPLY
@moodCode		1..1	code	Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN
id	S	0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
text	S	0..1	ED
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (required)
xmlText		0..1	st	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
reference	S	1..1	TEL
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		1..1	url
useablePeriod		0..*
useablePeriod			IVL_TS
useablePeriod			EIVL_TS
useablePeriod			PIVL_TS
useablePeriod			SXPR_TS
@use		0..*	cs	Binding: TelecommunicationAddressUse (2.0.0) (required)
thumbnail		0..1	ED
statusCode		0..1	CS	Binding: ActStatus (required)
effectiveTime	S	1..1
effectiveTimeAll Types				Content/Rules for all Types
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
priorityCode		0..*	CE	Binding: ActPriority (example)
repeatNumber		0..1	IVL_INT
independentInd		0..1	BL
quantity		0..1	PQ
expectedUseTime		0..1	IVL_TS
product		0..1	InfrastructureRoot
@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		0..1	cs	Binding: ParticipationTargetDirect (required) Fixed Value: PRD
manufacturedProduct		1..1	ManufacturedProduct
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant	S	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: DEV
@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		1..1	code	Binding: CDARoleClassRoot (required) Fixed Value: MANU
id	S	0..*	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	S	1..1	Device
@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		1..1	code	Binding: EntityClassDevice (required) Fixed Value: DEV
@determinerCode		1..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: Absent or Unknown Devices (preferred): Absent or Unknown Devices
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
playingEntity		0..1	PlayingEntity
scopingEntity		0..1	Entity
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
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
Supply.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.templateId:primary.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.classCode	required	Fixed Value: SPLY `http://terminology.hl7.org/ValueSet/v3-ActClassSupply`
Supply.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood\|2.0.0`
Supply.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Supply.text.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.text.compression	required	CDACompressionAlgorithm `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm`
Supply.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm\|2.0.0`
Supply.text.mediaType	example	MediaType `http://terminology.hl7.org/ValueSet/v3-MediaType`
Supply.text.representation	required	BinaryDataEncoding `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding`
Supply.text.reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.text.reference.use	required	TelecommunicationAddressUse `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse\|2.0.0`
Supply.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Supply.priorityCode	example	ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Supply.product.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.product.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.product.typeCode	required	Fixed Value: PRD `http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect`
Supply.participant.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.typeCode	required	Fixed Value: DEV `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Supply.participant.contextControlCode	required	Fixed Value: OP `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl`
Supply.participant.participantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.classCode	required	Fixed Value: MANU `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Supply.participant.participantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode`
Supply.participant.participantRole.playingDevice.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.playingDevice.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.playingDevice.classCode	required	Fixed Value: DEV `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice`
Supply.participant.participantRole.playingDevice.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Supply.participant.participantRole.playingDevice.code	preferred	IPSNoDevicesInfos `http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips` from this IG
Supply.participant.participantRole.playingDevice.manufacturerModelName	example	ManufacturerModelNameExample `http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample`
Supply.participant.participantRole.playingDevice.softwareName	example	SoftwareNameExample `http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample`

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Supply

Summary

Mandatory: 14 elements(4 nested mandatory elements)
Must-Support: 11 elements
Fixed: 8 elements

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Supply

Name	Flags	Card.	Type	Description & Constraints
Supply	S	0..*	Supply	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, 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.26
@classCode		1..1	code	Fixed Value: SPLY
@moodCode		1..1	code	Fixed Value: EVN
id	S	0..*	II
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
effectiveTime	S	1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
@type		1..1	string	XML Namespace: http://www.w3.org/2001/XMLSchema-instance XML: xsi (http://www.w3.org/2001/XMLSchema-instance) Fixed Value: IVL_TS
low	S	1..1
high		0..1
participant	S	1..*	Participant2
@typeCode		1..1	code	Fixed Value: DEV
participantRole	S	1..1	ParticipantRole
@classCode		1..1	code	Fixed Value: MANU
id	S	0..*	II
playingDevice	S	1..1	Device
@classCode		1..1	code	Fixed Value: DEV
@determinerCode		1..1	code	Fixed Value: INSTANCE
code	S	1..1	CE	Binding: Absent or Unknown Devices (preferred): Absent or Unknown Devices
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Supply.participant.participantRole.playingDevice.code	preferred	IPSNoDevicesInfos `http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Supply	S	0..*	Supply	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, 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.26
@classCode		1..1	code	Binding: ActClassSupply (required) Fixed Value: SPLY
@moodCode		1..1	code	Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN
id	S	0..*	II
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
effectiveTime	S	1..1
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
participant	S	1..*	Participant2
@typeCode		1..1	code	Binding: CDAParticipationType (required) Fixed Value: DEV
participantRole	S	1..1	ParticipantRole
@classCode		1..1	code	Binding: CDARoleClassRoot (required) Fixed Value: MANU
id	S	0..*	II
playingDevice	S	1..1	Device
@classCode		1..1	code	Binding: EntityClassDevice (required) Fixed Value: DEV
@determinerCode		1..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: Absent or Unknown Devices (preferred): Absent or Unknown Devices
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Supply.classCode	required	Fixed Value: SPLY `http://terminology.hl7.org/ValueSet/v3-ActClassSupply`
Supply.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood\|2.0.0`
Supply.participant.typeCode	required	Fixed Value: DEV `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Supply.participant.participantRole.classCode	required	Fixed Value: MANU `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Supply.participant.participantRole.playingDevice.classCode	required	Fixed Value: DEV `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice`
Supply.participant.participantRole.playingDevice.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Supply.participant.participantRole.playingDevice.code	preferred	IPSNoDevicesInfos `http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips` from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Supply	S	0..*	Supply	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, 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.26
@extension		0..1	st
@classCode		1..1	code	Binding: ActClassSupply (required) Fixed Value: SPLY
@moodCode		1..1	code	Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: EVN
id	S	0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
text	S	0..1	ED
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (required)
xmlText		0..1	st	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
reference	S	1..1	TEL
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		1..1	url
useablePeriod		0..*
useablePeriod			IVL_TS
useablePeriod			EIVL_TS
useablePeriod			PIVL_TS
useablePeriod			SXPR_TS
@use		0..*	cs	Binding: TelecommunicationAddressUse (2.0.0) (required)
thumbnail		0..1	ED
statusCode		0..1	CS	Binding: ActStatus (required)
effectiveTime	S	1..1
effectiveTimeAll Types				Content/Rules for all Types
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
priorityCode		0..*	CE	Binding: ActPriority (example)
repeatNumber		0..1	IVL_INT
independentInd		0..1	BL
quantity		0..1	PQ
expectedUseTime		0..1	IVL_TS
product		0..1	InfrastructureRoot
@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		0..1	cs	Binding: ParticipationTargetDirect (required) Fixed Value: PRD
manufacturedProduct		1..1	ManufacturedProduct
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant	S	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: DEV
@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		1..1	code	Binding: CDARoleClassRoot (required) Fixed Value: MANU
id	S	0..*	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	S	1..1	Device
@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		1..1	code	Binding: EntityClassDevice (required) Fixed Value: DEV
@determinerCode		1..1	code	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code	S	1..1	CE	Binding: Absent or Unknown Devices (preferred): Absent or Unknown Devices
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
playingEntity		0..1	PlayingEntity
scopingEntity		0..1	Entity
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
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
Supply.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.templateId:primary.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.classCode	required	Fixed Value: SPLY `http://terminology.hl7.org/ValueSet/v3-ActClassSupply`
Supply.moodCode	required	Fixed Value: EVN `http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood\|2.0.0`
Supply.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Supply.text.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.text.compression	required	CDACompressionAlgorithm `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm`
Supply.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm\|2.0.0`
Supply.text.mediaType	example	MediaType `http://terminology.hl7.org/ValueSet/v3-MediaType`
Supply.text.representation	required	BinaryDataEncoding `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding`
Supply.text.reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.text.reference.use	required	TelecommunicationAddressUse `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse\|2.0.0`
Supply.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Supply.priorityCode	example	ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Supply.product.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.product.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.product.typeCode	required	Fixed Value: PRD `http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect`
Supply.participant.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.typeCode	required	Fixed Value: DEV `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`
Supply.participant.contextControlCode	required	Fixed Value: OP `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl`
Supply.participant.participantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.classCode	required	Fixed Value: MANU `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot`
Supply.participant.participantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode`
Supply.participant.participantRole.playingDevice.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.playingDevice.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Supply.participant.participantRole.playingDevice.classCode	required	Fixed Value: DEV `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice`
Supply.participant.participantRole.playingDevice.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Supply.participant.participantRole.playingDevice.code	preferred	IPSNoDevicesInfos `http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips` from this IG
Supply.participant.participantRole.playingDevice.manufacturerModelName	example	ManufacturerModelNameExample `http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample`
Supply.participant.participantRole.playingDevice.softwareName	example	SoftwareNameExample `http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample`

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Supply

Summary

Mandatory: 14 elements(4 nested mandatory elements)
Must-Support: 11 elements
Fixed: 8 elements

Slices

This structure defines the following Slices:

The element 2 is sliced based on the values of Supply.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