International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPSObservationMedia - Detailed Descriptions

Draft as of 2021-09-02

Definitions for the 2.16.840.1.113883.10.22.4.23--20210902120216 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. ObservationMedia
Definition

This element must have an ID attribute  to be referenced from a element in the narrative of the section

Base definition for all types defined in FHIR type system.

Control1..*1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ObservationMedia.classCode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. ObservationMedia.moodCode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. ObservationMedia.templateId
SlicingThis element introduces a set of slices on ObservationMedia.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. ObservationMedia.templateId:primary
SliceNameprimary
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
6. ObservationMedia.templateId:primary.root
Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.23
7. ObservationMedia.languageCode
BindingThe codes SHALL be taken from AllLanguagesThe codes SHALL be taken from HumanLanguage All Language
8. ObservationMedia.value
Must Supporttrue
9. ObservationMedia.value.mediaType
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
10. ObservationMedia.value.representation
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
11. ObservationMedia.performer
Control0..1*
12. ObservationMedia.author

Guidance on how to interpret the contents of this table can be found here.

1. ObservationMedia
Definition

This element must have an ID attribute  to be referenced from a element in the narrative of the section

Base definition for all types defined in FHIR type system.

Control0..*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ObservationMedia.classCode
Control0..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOBS
Fixed ValueOBS
3. ObservationMedia.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
4. ObservationMedia.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ObservationMedia.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. ObservationMedia.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
6. ObservationMedia.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.23
7. ObservationMedia.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages All Language
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
8. ObservationMedia.value
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Must Supporttrue
XML RepresentationThe type of this property is determined using the xsi:type attribute.
9. ObservationMedia.value.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
10. ObservationMedia.value.representation
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
11. ObservationMedia.performer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
12. ObservationMedia.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author

Guidance on how to interpret the contents of this table can be found here.

1. ObservationMedia
Definition

This element must have an ID attribute  to be referenced from a element in the narrative of the section

Control0..*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ObservationMedia.ID
Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. ObservationMedia.classCode
Control0..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOBS
Fixed ValueOBS
4. ObservationMedia.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
5. ObservationMedia.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
6. ObservationMedia.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
7. ObservationMedia.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ObservationMedia.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
8. ObservationMedia.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
9. ObservationMedia.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
10. ObservationMedia.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
11. ObservationMedia.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
12. ObservationMedia.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.23
13. ObservationMedia.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. ObservationMedia.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
15. ObservationMedia.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages All Language
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
16. ObservationMedia.value
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Must Supporttrue
XML RepresentationThe type of this property is determined using the xsi:type attribute.
17. ObservationMedia.value.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
18. ObservationMedia.value.charset
Definition

For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
19. ObservationMedia.value.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
20. ObservationMedia.value.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..1
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
21. ObservationMedia.value.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
22. ObservationMedia.value.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
23. ObservationMedia.value.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
24. ObservationMedia.value.representation
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
25. ObservationMedia.value.data[x]
Definition

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

Control0..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
26. ObservationMedia.value.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
27. ObservationMedia.value.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
28. ObservationMedia.subject
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. ObservationMedia.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
30. ObservationMedia.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ObservationMedia.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
31. ObservationMedia.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
32. ObservationMedia.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
33. ObservationMedia.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
34. ObservationMedia.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
35. ObservationMedia.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
36. ObservationMedia.performer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
37. ObservationMedia.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
38. ObservationMedia.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. ObservationMedia.informant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
40. ObservationMedia.informant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ObservationMedia.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
41. ObservationMedia.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINF
Fixed ValueINF
42. ObservationMedia.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
43. ObservationMedia.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
44. ObservationMedia.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
45. ObservationMedia.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
46. ObservationMedia.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. ObservationMedia.entryRelationship.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
48. ObservationMedia.entryRelationship.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ObservationMedia.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. ObservationMedia.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
50. ObservationMedia.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
51. ObservationMedia.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
52. ObservationMedia.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
53. ObservationMedia.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
54. ObservationMedia.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
55. ObservationMedia.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
56. ObservationMedia.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
57. ObservationMedia.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
58. ObservationMedia.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
59. ObservationMedia.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
60. ObservationMedia.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
61. ObservationMedia.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
62. ObservationMedia.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
63. ObservationMedia.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
64. ObservationMedia.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. ObservationMedia.reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
66. ObservationMedia.reference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ObservationMedia.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
67. ObservationMedia.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
68. ObservationMedia.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
69. ObservationMedia.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
70. ObservationMedia.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
71. ObservationMedia.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
72. ObservationMedia.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
73. ObservationMedia.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition