IPS Planned Act - 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 Planned Act

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.39--20220715135511				Version: 1.1.0-ballot
Draft as of 2022-07-15				Computable Name: IPSPlannedAct
Other Identifiers: OID:2.16.840.1.113883.10.22.4.39 (use: official, )

This template represents a Planned Act. It may be a wrapper for intervention-type activities considered to be parts of the same intervention; or it could be used to describe planned acts not represented by the other care plan entry templates.

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 Act

Name	Flags	Card.	Type	Description & Constraints
Act		0..*	Act	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.39
@classCode		1..1	code	Fixed Value: ACT
@moodCode		1..1	code	Required Pattern: PRP
id	S	0..*	II
code	S	1..1	CD
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
statusCode	S	1..1	CS	Binding: ActStatus (required): ActStatus
effectiveTime	S	0..1	IVL_TS
performer		0..*	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Act.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Name	Flags	Card.	Type	Description & Constraints
Act		0..*	Act	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.39
@classCode		1..1	code	Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT
@moodCode		1..1	code	Binding: XDocumentActMood (2.0.0) (required) Required Pattern: PRP
id	S	0..*	II
code	S	1..1	CD	Binding: v3 Code System ActCode (example)
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
statusCode	S	1..1	CS	Binding: ActStatus (required): ActStatus
effectiveTime	S	0..1	IVL_TS
performer		0..*	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Act.classCode	required	Fixed Value: ACT `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct\|2.0.0`
Act.moodCode	required	Pattern: PRP `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood\|2.0.0`
Act.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Act.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Name	Flags	Card.	Type	Description & Constraints
Act		0..*	Act	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.39
@extension		0..1	st
@classCode		1..1	code	Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT
@moodCode		1..1	code	Binding: XDocumentActMood (2.0.0) (required) Required Pattern: PRP
@negationInd		0..1	bl
id	S	0..*	II
code	S	1..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	S	1..1	CS	Binding: ActStatus (required): ActStatus
effectiveTime	S	0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
languageCode		0..1	CS	Binding: AllLanguages (required)
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
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
Act.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.templateId:primary.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.classCode	required	Fixed Value: ACT `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct\|2.0.0`
Act.moodCode	required	Pattern: PRP `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood\|2.0.0`
Act.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Act.text.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.text.compression	required	CDACompressionAlgorithm `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm`
Act.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm\|2.0.0`
Act.text.mediaType	example	MediaType `http://terminology.hl7.org/ValueSet/v3-MediaType`
Act.text.representation	required	BinaryDataEncoding `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding`
Act.text.reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.text.reference.use	required	TelecommunicationAddressUse `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse\|2.0.0`
Act.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Act.priorityCode	example	ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Act.languageCode	required	AllLanguages `http://hl7.org/fhir/ValueSet/all-languages`

This structure is derived from Act

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Act

Name	Flags	Card.	Type	Description & Constraints
Act		0..*	Act	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.39
@classCode		1..1	code	Fixed Value: ACT
@moodCode		1..1	code	Required Pattern: PRP
id	S	0..*	II
code	S	1..1	CD
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
statusCode	S	1..1	CS	Binding: ActStatus (required): ActStatus
effectiveTime	S	0..1	IVL_TS
performer		0..*	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Act.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Act		0..*	Act	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.39
@classCode		1..1	code	Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT
@moodCode		1..1	code	Binding: XDocumentActMood (2.0.0) (required) Required Pattern: PRP
id	S	0..*	II
code	S	1..1	CD	Binding: v3 Code System ActCode (example)
text	S	0..1	ED
reference	S	1..1	TEL
@value		1..1	url
statusCode	S	1..1	CS	Binding: ActStatus (required): ActStatus
effectiveTime	S	0..1	IVL_TS
performer		0..*	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Act.classCode	required	Fixed Value: ACT `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct\|2.0.0`
Act.moodCode	required	Pattern: PRP `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood\|2.0.0`
Act.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Act.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Act		0..*	Act	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.39
@extension		0..1	st
@classCode		1..1	code	Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT
@moodCode		1..1	code	Binding: XDocumentActMood (2.0.0) (required) Required Pattern: PRP
@negationInd		0..1	bl
id	S	0..*	II
code	S	1..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	S	1..1	CS	Binding: ActStatus (required): ActStatus
effectiveTime	S	0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
languageCode		0..1	CS	Binding: AllLanguages (required)
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
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
Act.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.templateId:primary.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.classCode	required	Fixed Value: ACT `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct\|2.0.0`
Act.moodCode	required	Pattern: PRP `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood\|2.0.0`
Act.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Act.text.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.text.compression	required	CDACompressionAlgorithm `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm`
Act.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm\|2.0.0`
Act.text.mediaType	example	MediaType `http://terminology.hl7.org/ValueSet/v3-MediaType`
Act.text.representation	required	BinaryDataEncoding `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding`
Act.text.reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
Act.text.reference.use	required	TelecommunicationAddressUse `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse\|2.0.0`
Act.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Act.priorityCode	example	ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Act.languageCode	required	AllLanguages `http://hl7.org/fhir/ValueSet/all-languages`

This structure is derived from Act

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

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