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 Survey Panel

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.42--20200508190226 Version: 1.1.0-ballot
Draft as of 2020-05-08 Computable Name: IPSSurveyPanel
Other Identifiers: OID:2.16.840.1.113883.10.22.4.42 (use: official, )

A survey panel collects related survey observations.

Usage:

Formal Views of Template Content

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

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.42
... @classCode 1..1 code Fixed Value: CLUSTER
... @moodCode 0..1 code Fixed Value: EVN
... code S 1..1 CD
... statusCode S 1..1 CS
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 0..1 IVL_TS
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by value:profile
.... component:component-1 SC 1..1 OrganizerComponent component-1: contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
..... Slices for observation Content/Rules for all slices
...... observation:component-1 S 1..* IPSSurveyObservation Base for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
component-1nullOrganizer.component:component-1contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.42
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 0..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... code S 1..1 CD Binding: v3 Code System ActCode (example)
... statusCode S 1..1 CS Binding: ActStatus (required)
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 0..1 IVL_TS
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by value:profile
.... component:component-1 SC 1..1 OrganizerComponent component-1: contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
..... Slices for observation Content/Rules for all slices
...... observation:component-1 S 1..* IPSSurveyObservation Base for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus

Constraints

IdGradePath(s)DetailsRequirements
component-1nullOrganizer.component:component-1contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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
.... 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.42
..... @extension 0..1 st
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 0..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... id S 0..* II
... code S 1..1 CD Binding: v3 Code System ActCode (example)
... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: text (urn:hl7-org:sdtc)
... statusCode S 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: completed
.... @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)
... effectiveTime S 0..1 IVL_TS
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by value:profile
.... component:component-1 SC 1..1 OrganizerComponent component-1: contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
..... @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: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... sequenceNumber 0..1 INT
..... sdtcPriorityNumber 0..1 INT XML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... Slices for observation Content/Rules for all slices
...... observation:component-1 S 1..* IPSSurveyObservation Base for all types and resources
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:component-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:component-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:component-1.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
component-1nullOrganizer.component:component-1contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
:

This structure is derived from Organizer

Summary

Mandatory: 9 elements
Must-Support: 7 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organizer.templateId
  • The element 1 is sliced based on the value of Organizer.component

Differential View

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.42
... @classCode 1..1 code Fixed Value: CLUSTER
... @moodCode 0..1 code Fixed Value: EVN
... code S 1..1 CD
... statusCode S 1..1 CS
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 0..1 IVL_TS
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by value:profile
.... component:component-1 SC 1..1 OrganizerComponent component-1: contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
..... Slices for observation Content/Rules for all slices
...... observation:component-1 S 1..* IPSSurveyObservation Base for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
component-1nullOrganizer.component:component-1contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.42
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 0..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... code S 1..1 CD Binding: v3 Code System ActCode (example)
... statusCode S 1..1 CS Binding: ActStatus (required)
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 0..1 IVL_TS
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by value:profile
.... component:component-1 SC 1..1 OrganizerComponent component-1: contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
..... Slices for observation Content/Rules for all slices
...... observation:component-1 S 1..* IPSSurveyObservation Base for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus

Constraints

IdGradePath(s)DetailsRequirements
component-1nullOrganizer.component:component-1contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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
.... 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.42
..... @extension 0..1 st
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 0..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... id S 0..* II
... code S 1..1 CD Binding: v3 Code System ActCode (example)
... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: text (urn:hl7-org:sdtc)
... statusCode S 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: completed
.... @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)
... effectiveTime S 0..1 IVL_TS
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by value:profile
.... component:component-1 SC 1..1 OrganizerComponent component-1: contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
..... @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: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... sequenceNumber 0..1 INT
..... sdtcPriorityNumber 0..1 INT XML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... Slices for observation Content/Rules for all slices
...... observation:component-1 S 1..* IPSSurveyObservation Base for all types and resources
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:component-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:component-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:component-1.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
component-1nullOrganizer.component:component-1contains IPS Survey Observation 2.16.840.1.113883.10.22.4.43 (2020-05-08)
:

This structure is derived from Organizer

Summary

Mandatory: 9 elements
Must-Support: 7 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organizer.templateId
  • The element 1 is sliced based on the value of Organizer.component

 

Other representations of profile: CSV, Excel