HL7.CDA.UV.IPS\IPS Translation Section - Definitions

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

Resource Profile: IPSTranslationSection - Detailed Descriptions

Draft as of 2021-09-02

Definitions for the 2.16.840.1.113883.10.22.3.15--20210902120441 resource profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

1. Section
Control	1..*1
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Section.id
Control	0..*1
Must Support	true
3. Section.title
Control	10..1
Must Support	true
4. Section.text
Control	10..1
5. Section.languageCode
Control	10..1
Binding	The codes SHALL be taken from AllLanguagesThe codes SHALL be taken from HumanLanguage All Language
Must Support	true

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

1. Section
Definition	Base definition for all types defined in FHIR type system.
Control	0..*
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Section.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassRecordOrganizer
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	DOCSECT
Fixed Value	DOCSECT
3. Section.moodCode
Control	1..1
Binding	The codes SHALL be taken from ActMood
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	EVN
Fixed Value	EVN
4. Section.id
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Must Support	true
5. Section.title
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ST
Must Support	true
6. Section.text
Control	1..1
Type	xhtml
Must Support	true
XML Representation	This property is represented as CDA Text in the XML.
7. Section.languageCode
Control	1..1
Binding	The codes SHALL be taken from AllLanguages All Language
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
Must Support	true

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

1. Section
Definition	Base definition for all types defined in FHIR type system.
Control	0..*
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Section.ID
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
3. Section.nullFlavor
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
4. Section.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassRecordOrganizer
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	DOCSECT
Fixed Value	DOCSECT
5. Section.moodCode
Control	1..1
Binding	The codes SHALL be taken from ActMood
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	EVN
Fixed Value	EVN
6. Section.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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
7. Section.id
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Must Support	true
8. Section.code
Control	0..1
Binding	The codes SHALL be taken from DocumentSectionType; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
9. Section.title
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ST
Must Support	true
10. Section.text
Control	1..1
Type	xhtml
Must Support	true
XML Representation	This property is represented as CDA Text in the XML.
11. Section.confidentialityCode
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
12. Section.languageCode
Control	1..1
Binding	The codes SHALL be taken from AllLanguages All Language
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
Must Support	true
13. Section.subject
Control	0..1
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Section.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.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
15. Section.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.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, 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.
Invariants	Defined 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())
Slicing	This element introduces a set of slices on Section.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
16. Section.subject.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationTargetSubject
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	SBJ
Fixed Value	SBJ
17. Section.subject.contextControlCode
Control	1..1
Binding	The codes SHALL be taken from ContextControl
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	OP
Fixed Value	OP
18. Section.subject.awarenessCode
Control	0..1
Binding	The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
19. Section.subject.relatedSubject
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
20. Section.author
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Author
21. Section.informant
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Section.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.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
23. Section.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.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, 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.
Invariants	Defined 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())
Slicing	This element introduces a set of slices on Section.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
24. Section.informant.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationInformationGenerator
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	INF
Fixed Value	INF
25. Section.informant.contextControlCode
Control	1..1
Binding	The codes SHALL be taken from ContextControl
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	OP
Fixed Value	OP
26. Section.informant.assignedEntity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
27. Section.informant.relatedEntity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
28. Section.entry
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) only-one-statement: SHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act. (: (observation \| regionOfInterest \| observationMedia \| substanceAdministration \| supply \| procedure \| encounter \| organizer \| act).count() = 1)
29. Section.entry.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
30. Section.entry.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.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, 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.
Invariants	Defined 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())
Slicing	This element introduces a set of slices on Section.entry.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
31. Section.entry.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	COMP
32. Section.entry.contextConductionInd
Control	1..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	true
33. Section.entry.observation
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Observation
34. Section.entry.regionOfInterest
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
35. Section.entry.observationMedia
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
36. Section.entry.substanceAdministration
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
37. Section.entry.supply
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Supply
38. Section.entry.procedure
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Procedure
39. Section.entry.encounter
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Encounter
40. Section.entry.organizer
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Organizer
41. Section.entry.act
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Act
42. Section.component
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Section.component.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
44. Section.component.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.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, 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.
Invariants	Defined 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())
Slicing	This element introduces a set of slices on Section.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
45. Section.component.typeCode
Definition	Drawn from concept domain DocumentSectionType
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	COMP
Fixed Value	COMP
46. Section.component.contextConductionInd
Control	1..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	true
47. Section.component.section
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Section