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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: IPS ObservationMedia

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 ObservationMedia

Name	Flags	Card.	Type	Description & Constraints
ObservationMedia		0..*	ObservationMedia	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, languageCode, value, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2 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.23
@classCode		0..1	code	Fixed Value: OBS
@moodCode		0..1	code	Fixed Value: EVN
languageCode		0..1	CS	Binding: AllLanguages (required): All Languages
value	S	1..1	ED
@mediaType		1..1	code
@representation		1..1	code
performer		0..1	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ObservationMedia.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages

Name	Flags	Card.	Type	Description & Constraints
ObservationMedia		0..*	ObservationMedia	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, languageCode, value, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2 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.23
@classCode		0..1	code	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		0..1	code	Binding: CDAActMood (required) Fixed Value: EVN
languageCode		0..1	CS	Binding: AllLanguages (required): All Languages
value	S	1..1	ED
@mediaType		1..1	code	Binding: MediaType (example)
@representation		1..1	code	Binding: CDABinaryDataEncoding (required)
performer		0..1	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ObservationMedia.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
ObservationMedia.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood
ObservationMedia.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages
ObservationMedia.value.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ObservationMedia.value.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding

Name	Flags	Card.	Type	Description & Constraints
ObservationMedia		0..*	ObservationMedia	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, languageCode, value, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2 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.23
@extension		0..1	st
@ID		0..1	xs:ID
@classCode		0..1	code	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		0..1	code	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
languageCode		0..1	CS	Binding: AllLanguages (required): All Languages
value	S	1..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		1..1	code	Binding: MediaType (example)
@representation		1..1	code	Binding: CDABinaryDataEncoding (required)
xmlText		0..1	st	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
reference		0..1	TEL
thumbnail		0..1	ED
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..1	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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ObservationMedia.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.templateId:primary.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
ObservationMedia.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood
ObservationMedia.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages
ObservationMedia.value.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.value.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
ObservationMedia.value.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ObservationMedia.value.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ObservationMedia.value.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding

This structure is derived from ObservationMedia

Summary

Mandatory: 6 elements
Must-Support: 2 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from ObservationMedia

Name	Flags	Card.	Type	Description & Constraints
ObservationMedia		0..*	ObservationMedia	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, languageCode, value, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2 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.23
@classCode		0..1	code	Fixed Value: OBS
@moodCode		0..1	code	Fixed Value: EVN
languageCode		0..1	CS	Binding: AllLanguages (required): All Languages
value	S	1..1	ED
@mediaType		1..1	code
@representation		1..1	code
performer		0..1	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ObservationMedia.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ObservationMedia		0..*	ObservationMedia	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, languageCode, value, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2 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.23
@classCode		0..1	code	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		0..1	code	Binding: CDAActMood (required) Fixed Value: EVN
languageCode		0..1	CS	Binding: AllLanguages (required): All Languages
value	S	1..1	ED
@mediaType		1..1	code	Binding: MediaType (example)
@representation		1..1	code	Binding: CDABinaryDataEncoding (required)
performer		0..1	Performer2
author		0..*	Author
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ObservationMedia.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
ObservationMedia.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood
ObservationMedia.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages
ObservationMedia.value.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ObservationMedia.value.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ObservationMedia		0..*	ObservationMedia	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, languageCode, value, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2 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.23
@extension		0..1	st
@ID		0..1	xs:ID
@classCode		0..1	code	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		0..1	code	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
languageCode		0..1	CS	Binding: AllLanguages (required): All Languages
value	S	1..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		1..1	code	Binding: MediaType (example)
@representation		1..1	code	Binding: CDABinaryDataEncoding (required)
xmlText		0..1	st	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
reference		0..1	TEL
thumbnail		0..1	ED
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..1	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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ObservationMedia.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.templateId:primary.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
ObservationMedia.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood
ObservationMedia.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages
ObservationMedia.value.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ObservationMedia.value.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
ObservationMedia.value.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ObservationMedia.value.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ObservationMedia.value.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding

This structure is derived from ObservationMedia

Summary

Mandatory: 6 elements
Must-Support: 2 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel