IPSEntryInternalReference

Template IPS Internal Reference 2017‑05‑02

2.16.840.1.113883.10.22.4.31

Effective Date

2017‑05‑02

Status

Under pre-publication review

Version Label

STU1

Name

IPSEntryInternalReference

Display Name

IPS Internal Reference

Description

This template is used to reference (point to) information contained in other entries within the same document.

Classification

CDA Entry Level Template

Open/Closed

Open (other than defined elements are allowed)

Used by / Uses

Used by 3 transactions and 6 templates, Uses 0 templates

Used by	as	Name	Version
2.16.840.1.113883.3.1937.777.15.4.6	Transaction	Create Medication Administration	2019‑02‑17
2.16.840.1.113883.3.1937.777.15.4.2	Transaction	Create Medication Order	2017‑05‑10
2.16.840.1.113883.3.1937.777.15.4.4	Transaction	Create Medication Statement	2017‑05‑10
2.16.840.1.113883.10.21.4.1	Containment	UV Medication Order (2023)	2023‑01‑31 11:29:28
2.16.840.1.113883.10.21.4.7	Containment	UV Medication Statement (2023)	2023‑01‑30 08:32:34
2.16.840.1.113883.10.21.4.13	Containment	UV Medication Administration (2023)	2023‑01‑30 08:31:37
2.16.840.1.113883.10.22.4.17	Containment	IPS Procedure Entry (STU1)	2017‑03‑27
2.16.840.1.113883.10.22.4.17	Containment	IPS Procedure Entry (2021)	2020‑07‑14 16:35:58
2.16.840.1.113883.10.22.4.38	Containment	IPS Planned Procedure (TI-2020)	2020‑05‑08 17:38:48

Relationship

Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.4.1 IHE Internal Reference Entry (2013‑12‑20)

ref

IHE-PCC-

Example

Reference to an uncoded element

Item	DT	Card	Conf	Description	Label
hl7:act			R		IPSEence
@classCode	cs	1 … 1	F	ACT
@moodCode	cs	1 … 1	R	The @moodCode of the reference SHALL match the @moodCode of the referenced element
	Variable let	Name	refMoodCode
	Variable let	Value	@moodCode
	Variable let	Name	refID
	Variable let	Value	concat(hl7:id[1]/@root,'#',hl7:id[1]/@extension)
	Variable let	Name	refCode
	Variable let	Value	concat(hl7:code[1]/@code,'#',hl7:code[1]/@codeSystem)
	Variable let	Name	reffedObject
	Variable let	Value	(ancestor::hl7:ClinicalDocument//:id[concat(@root,'#',@extension)=$refID][not(preceding-sibling::hl7:templateId/@root='1.3.6.1.4.1.19376.1.5.3.1.4.4.1')]/parent::)[1]
	Schematron assert	role	error
		test	not(exists($reffedObject)) or $reffedObject[@moodCode=$refMoodCode]
		Message	The @moodCode of the reference SHALL match the @moodCode of the referenced element
	Schematron assert	role	error
		test	exists($reffedObject)
		Message	The root and extension attributes SHALL identify an element defined elsewhere in the same document.
	Schematron assert	role	error
		test	not(exists($reffedObject)) or ($reffedObject[not(:code/@code)] and hl7:code[@nullFlavor='NA']) or $reffedObject/:code[concat(@code,'#',@codeSystem)=$refCode]
		Message	The code of the reference SHALL match the code of the referenced element
hl7:templateId	II	1 … 1	M		IPSEence
@root	uid	1 … 1	F	2.16.840.1.113883.10.22.4.31
hl7:id	II	1 … 1	R	This element shall be present. The root and extension attributes shall identify an element defined elsewhere in the same document.	IPSEence
hl7:code	CD	1 … 1	R	This element shall be present. It shall be valued when the internal reference is to element that has a <code> element, and shall have the same attributes as the <code> element in the act it references. If the element it references does not have a <code> element, then the nullFlavor attribute should be set to "NA".	IPSEence
@nullFlavor	cs	0 … 1	F	NA

Template
Show index

Template

Template IPS Internal Reference 2017‑05‑02