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 Internal Reference

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.31--20170502000000 Version: 1.1.0-ballot
Draft as of 2017-05-02 Computable Name: IPSEntryInternalReference
Other Identifiers: OID:2.16.840.1.113883.10.22.4.31 (use: official, )

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

Usage:

Formal Views of Template Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act SC 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)
MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element
MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document.
MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element
... @classCode 1..1 code Fixed Value: ACT
... @moodCode 1..1 code
... 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.31
... code S 1..1 CD
.... @nullFlavor 0..1 code Fixed Value: NA

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l287l23l17errorActThe @moodCode of the reference SHALL match the @moodCode of the referenced element
:
MD1557037N1l27l287l23l19errorActThe root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
MD1557037N1l27l287l23l21errorActThe code of the reference SHALL match the code of the referenced element
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act SC 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)
MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element
MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document.
MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element
... 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.31
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 code Binding: CDANullFlavor (required)
Fixed Value: NA

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredXActClassDocumentEntryAct
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredXDocumentActMood
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredFixed Value: NA
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l287l23l17errorActThe @moodCode of the reference SHALL match the @moodCode of the referenced element
:
MD1557037N1l27l287l23l19errorActThe root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
MD1557037N1l27l287l23l21errorActThe code of the reference SHALL match the code of the referenced element
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act SC 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)
MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element
MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document.
MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element
... @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: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.31
..... @extension 0..1 st
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
... @negationInd 0..1 bl
... id S 1..1 II
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 code Binding: CDANullFlavor (required)
Fixed Value: NA
.... @code 0..1 cs
.... @codeSystem 0..1 oid, uuid, ruid
.... @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
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredXActClassDocumentEntryAct
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredXDocumentActMood
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredFixed Value: NA
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l287l23l17errorActThe @moodCode of the reference SHALL match the @moodCode of the referenced element
:
MD1557037N1l27l287l23l19errorActThe root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
MD1557037N1l27l287l23l21errorActThe code of the reference SHALL match the code of the referenced element
:

This structure is derived from Act

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 3 elements
Fixed: 3 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act SC 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)
MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element
MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document.
MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element
... @classCode 1..1 code Fixed Value: ACT
... @moodCode 1..1 code
... 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.31
... code S 1..1 CD
.... @nullFlavor 0..1 code Fixed Value: NA

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l287l23l17errorActThe @moodCode of the reference SHALL match the @moodCode of the referenced element
:
MD1557037N1l27l287l23l19errorActThe root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
MD1557037N1l27l287l23l21errorActThe code of the reference SHALL match the code of the referenced element
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act SC 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)
MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element
MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document.
MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element
... 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.31
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 code Binding: CDANullFlavor (required)
Fixed Value: NA

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredXActClassDocumentEntryAct
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredXDocumentActMood
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredFixed Value: NA
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l287l23l17errorActThe @moodCode of the reference SHALL match the @moodCode of the referenced element
:
MD1557037N1l27l287l23l19errorActThe root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
MD1557037N1l27l287l23l21errorActThe code of the reference SHALL match the code of the referenced element
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act SC 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)
MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element
MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document.
MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element
... @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: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.31
..... @extension 0..1 st
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
... @negationInd 0..1 bl
... id S 1..1 II
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 code Binding: CDANullFlavor (required)
Fixed Value: NA
.... @code 0..1 cs
.... @codeSystem 0..1 oid, uuid, ruid
.... @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
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredXActClassDocumentEntryAct
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredXDocumentActMood
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredFixed Value: NA
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l287l23l17errorActThe @moodCode of the reference SHALL match the @moodCode of the referenced element
:
MD1557037N1l27l287l23l19errorActThe root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
MD1557037N1l27l287l23l21errorActThe code of the reference SHALL match the code of the referenced element
:

This structure is derived from Act

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 3 elements
Fixed: 3 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