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: IPSResultOrganizer - Detailed Descriptions

Draft as of 2017-03-02

Definitions for the 2.16.840.1.113883.10.22.4.9--20170302000000 resource profile.

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

1. Organizer
Control1..*1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Organizer.classCode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Organizer.moodCode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. Organizer.templateId
SlicingThis element introduces a set of slices on Organizer.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Organizer.templateId:primary
SliceNameprimary
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
6. Organizer.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.9
7. Organizer.id
8. Organizer.code
Control10..1
BindingThe codes SHALL be taken from IPS Results OrganizerThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable IPS Results Organize
Must Supporttrue
9. Organizer.statusCode
BindingThe codes SHALL be taken from x_ActStatusActiveCompleteThe codes SHALL be taken from ActStatus x_ActStatusActiveComplet
Must Supporttrue
10. Organizer.effectiveTime
11. Organizer.effectiveTime.low
Control0..1
12. Organizer.effectiveTime.high
Control0..1
13. Organizer.performer
Definition

When present, this element represents the organization who performed the set of observations grouped under this organizer.

Must Supporttrue
14. Organizer.author
Must Supporttrue

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

1. Organizer
Definition

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. Organizer.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Organizer.moodCode
Control1..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. Organizer.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 Organizer.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Organizer.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. Organizer.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.9
7. Organizer.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
8. Organizer.code
Control1..1
BindingThe codes SHALL be taken from IPS Results Organizer IPS Results Organize
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Must Supporttrue
9. Organizer.statusCode
Control1..1
BindingThe codes SHALL be taken from x_ActStatusActiveComplete x_ActStatusActiveComplet
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Must Supporttrue
10. Organizer.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
11. Organizer.effectiveTime.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
12. Organizer.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
13. Organizer.performer
Definition

When present, this element represents the organization who performed the set of observations grouped under this organizer.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Must Supporttrue
14. Organizer.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
Must Supporttrue

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

1. Organizer
Definition

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. Organizer.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Organizer.moodCode
Control1..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. Organizer.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Organizer.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Organizer.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 Organizer.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
7. Organizer.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
8. Organizer.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.
9. Organizer.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.
10. Organizer.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.
11. Organizer.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.9
12. Organizer.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.
13. Organizer.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
14. Organizer.code
Control1..1
BindingThe codes SHALL be taken from IPS Results Organizer IPS Results Organize
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Must Supporttrue
15. Organizer.statusCode
Control1..1
BindingThe codes SHALL be taken from x_ActStatusActiveComplete x_ActStatusActiveComplet
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Must Supporttrue
16. Organizer.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
17. Organizer.effectiveTime.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. Organizer.effectiveTime.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Organizer.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Organizer.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Organizer.effectiveTime.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
22. Organizer.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
23. Organizer.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
24. Organizer.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
25. Organizer.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()))
26. Organizer.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
27. Organizer.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 Organizer.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. Organizer.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
29. Organizer.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
30. Organizer.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
31. Organizer.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
32. Organizer.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
33. Organizer.performer
Definition

When present, this element represents the organization who performed the set of observations grouped under this organizer.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Must Supporttrue
34. Organizer.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
Must Supporttrue
35. Organizer.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Organizer.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
37. Organizer.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 Organizer.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
38. Organizer.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
39. Organizer.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
40. Organizer.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
41. Organizer.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
42. Organizer.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
43. Organizer.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Organizer.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
45. Organizer.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 Organizer.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. Organizer.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
47. Organizer.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
48. Organizer.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
49. Organizer.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
50. Organizer.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
51. Organizer.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
52. Organizer.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
53. Organizer.component
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Organizer.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.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
55. Organizer.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.

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 Organizer.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
56. Organizer.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
57. Organizer.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
58. Organizer.component.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
59. Organizer.component.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
60. Organizer.component.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
61. Organizer.component.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
62. Organizer.component.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
63. Organizer.component.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
64. Organizer.component.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
65. Organizer.component.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
66. Organizer.component.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
67. Organizer.component.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
68. Organizer.component.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act